Skip to content

Register a database

5 min · Screen: /databases/new · Needs: Permissions.Databases.Create

  1. Open Infrastructure › Database instances and click Register instance

  2. Pick the Server, a Name and the Engine

    The list covers 31 engines, plus any you add yourself; see Supported databases.

  3. Say where it runs

    On the host, In a Docker container, In a Podman container, or Remote or managed, through the server. For a container give its name - it survives a re-create - or its compose project and service.

  4. Say how to sign in

    Password, peer or socket, certificate, connection string, or none - as the engine allows. A password is stored encrypted and handed to the tool on its standard input, never on a command line.

  5. Choose where the dump tool runs

    • automatic - the platform decides (recommended).

    • in the container - the database’s own container runs the tool.

    • on the host - the tool installed on the server.

    • ephemeral container - a throw-away container with the tool, e.g. when the database container has none.

    • platform tunnel - the platform runs the tool itself through an SSH tunnel.

  6. Save - the platform tests it

    The instance shows Reachable with its version, or the reason it is not.

Reachable

Signed in and the version was read.

Version not supported

Reached, but the version is outside what the engine supports.

Unreachable / Authentication failed

Check the host, port, container name and sign-in.

Unknown

Not tested yet.