Readyset Docs

Connect a database

Add connection details, import cloud databases, or configure an SSH tunnel.

A target is a named database connection. Select one at the top of the sidebar to open its Database page or ask questions about it.

Open Settings, then Targets, to manage connections.

Adding a target by hand

  1. Select Add target in Settings and open Manual setup.
  2. Enter a name, engine, host, port, database, and user. Quick Setup can fill these fields from a connection URL. Target names must be unique. RDST checks as you type and when you save. If the name is taken, it says A target named <name> already exists.
  3. Enter the database password.
  4. Expand Connect via SSH jump host if you need a tunnel, or Advanced for TLS settings.
  5. Select Test connection, then Add target. The Turn on monitoring dialog opens next for that database.
postgresql://readonly@db.example.com:5432/myapp

Manual setup in Add target, with Quick setup and the connection fields

Check a connection

The target list shows the engine, host, port, server version, and measured round-trip latency. Test checks one target; Check all checks the list.

Password stored means RDST can use the saved keychain credential. Tunnel active means its SSH tunnel is open.

Use a read-only account with access to application tables and query statistics. RDST warns when it detects write privileges. How to create a read-only user opens example grants for an administrator to run.

Passwords are saved in the operating system's keychain or read from a named environment variable. They're never written into config.toml.

Start monitoring

After you add a database, from Targets or during your first launch, the Turn on monitoring dialog opens next in the same flow. RDST checks statistics collection and access before taking its first readings.