SSH Configuration

Table of contents

• Configuring SSH tunnels
• Advanced settings

SSH (Secure Shell) encrypts the connection between a client and a server. In CloudBeaver, you can configure an SSH tunnel to connect to a database on a remote server that isn't directly accessible from your network.

CloudBeaver supports the following SSH authentication methods:

• Username/password
• Public key authentication

Configuring SSH tunnels

Note: SSH tunnel support can be disabled by an administrator in Server Configuration. When disabled, the SSH Tunnel tab is hidden and existing SSH-based connections stop working with a tunneling restriction error. To keep using such connections, reconfigure them without SSH tunneling.

1. Start by creating a connection.

2. Set the hostname to localhost and the port to match the remote database in Main tab.

   Tip: This step ensures CloudBeaver connects to the database on the remote machine through the SSH tunnel, treating the remote database as if it were running locally.

   If the database server listens on port 3306, the SSH tunnel forwards this port to your server machine. In CloudBeaver, set the hostname to localhost and the port to 3306 to use the local end of the tunnel. Ensure that the local port specified in the SSH tunnel configuration matches the port set in CloudBeaver's connection settings. Verify that no other local services use the same port to avoid conflicts.

3. Go to the SSH Tunnel tab in the connection settings.

4. Enable the checkbox Use SSH Tunnel and choose the authentication method from Authentication method dropbox.

5. Depending on the chosen authentication method, configure the required settings:

   Field	Description
   Host	Enter the hostname or IP address of the SSH server.
   Port	Specify the SSH server port (default is 22).
   User	Provide the username to authenticate with.
   Password	Enter the password for the specified user.
   Private key	Paste the private key or use the File button to upload it.
   Passphrase	(Optional) Enter the passphrase if the private key is encrypted.

6. Click Test tunnel to verify the parameters.

Tip: To avoid entering credentials every time, enable the Save credentials for the current user option. Depending on the connection type, the checkbox name may vary. For more details, see Credential saving options.

Advanced settings

Setting	Description
Alive interval (ms)	Sets the interval in milliseconds for sending a keep-alive packet to keep the connection active. A value of 0 disables keep-alive packets.
Connect timeout (ms)	Sets the maximum time in milliseconds to establish a tunnel connection before timing out.