Skip to content

Partner SSH to ODS Connection Docs

Some users will want to connect to the ODS databases. At EA we use an SSH server deployment that allows access for users based on a Public/Private key that is linked to their GitHub account.

To be able to use the SSH tunnel to connect to the Postgres DB, a GitHub user will need to exist and have an associated Public Key attached to the user account. The private key will need to be saved somewhere on the connecting machine, such that it is accessible while setting up the db connection.

Once a GitHub account is created and the key generated, EA will need to be notified of the GitHub User ID to add access to the SSH server for the connection.

After EA updates the server, then those trying to connect can use their software of choice to create the connection and SSH tunnel. Provided are some steps to connect via DBeaver or PGAdmin, two common database management tools.

Prerequisites

Create a GitHub user if one does not already exist for user trying to create the connection.

GitHub Method (Used with shared SSH server)

  1. Create GitHub account

    https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account

  2. Confirm email

  3. Create an SSH key for GitHub account
    https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

When creating the ssh key use:

ssh-keygen -t rsa-sha2-256 -b4096 -C "emailaddress"

NOTE: It is recommended per GitHub documentation to provide a passphrase to protect your key file. If you choose to do this, you will be asked for the passphrase when you connect to the ssh tunnel. It will be important to save this passphrase locally in a password manager. Be sure to save your key file to a location you remember and is backed up.

  1. Adding SSH Key to GitHub Account

    https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account

    NOTE: When trying to add .pub to github, open the file in a text editor, like Notepad, to copy if you can't get clip to work.

  2. Provide GitHub user name to EA

    • EA will update internally to allow connection
    • EA will communicate back out once update is complete

Create the connection in connection client of choice

DBeaver

Download and Install Dbeaver: https://dbeaver.io/download/

Creating connection: https://dbeaver.com/docs/dbeaver/Create-Connection/

Setting up SSH connection: https://dbeaver.com/docs/dbeaver/SSH-Configuration/

See separate document on EA's process on how to setup the connection with DBeaver

PGAdmin

Download and Installation: https://www.pgadmin.org/download/

Getting Started with PGAdmin: https://www.pgadmin.org/docs/pgadmin4/development/getting_started.html

See separate document on EA's process on how to setup the connection with PGAdmin