Team Edition Documentation

DOWNLOAD pdf

SSH Configuration

Table of contents

Overview

Team Edition supports the following SSH authentication methods:

  • Username/password

  • Public key authentication

Configuring SSH tunnels
  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 Team Edition connects to the database on the remote machine through the SSH tunnel, treating the remote database as if it were running locally.

For example, if the database server listens on port 3306, the SSH tunnel forwards this port to your server machine. In Team Edition, 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 Team Edition's connection settings. Verify that no other local services use the same port to avoid conflicts.

  1. Go to the SSH Tunnel tab in the connection settings.
  2. Enable the checkbox Use SSH Tunnel and choose the authentication method from Authentication method dropbox.
  3. 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.
  1. 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.