FumadocsDocs

Connecting your Database with Turbular

Step 1: Collect Your Database Credentials

Before you begin connecting to Turbular, you will need the following information from your database.

  • Type of your Database (f.e. MySql, Postgres etc.)
  • IP address
  • Port number
  • Username
  • Password
  • Name of your Database

To use an example lets assume I have a hosted Postgres database on AWS with the following credentials:

  • IP address: your.host.address
  • Port number: 1234
  • Username: interesting_user
  • Password: extremely_secret_password
  • Name of your Database: insightful_db

First you will click on "Add Source" button on the Datasource page. Then the following selection will be presented to you Datasource selection Since we are interested in adding a Postgres database, we click on the "Database" field. Afterward a new form will open in which you will be asked to fill in your database credentials. Using our example credentials the form would look like the following: Add database form field

Step 1.5: Collect Your SSH Credentials (Optional)

If your database is hosted in a private network you will need to additionally provide SSH credentials as otherwise your database is not reachable from the outside. Turbular uses your SSH credentials then to log into to the private network in order to connect to your database. There are two ways how you can provide your SSH credentials

  1. Option 1 (Credentials): Connect via SSH username and password
  2. Option 2 (Key): Connect via SSH username and SSH key

After you have gathered your credentials, you can provide them to Turbular in the following way. First enable the checkmark after "Use SSH to connect?". Afterward a new field "Select SSH Connection Type" will open up in which you can select how you want to provide your SSH credentials.

Credentials

After selecting the "Credentials" in "Select SSH Connection Type" the following fields will appear SSH credentials form field The following information will be required from you:

  • Ssh_ip: The public IP address of your private network
  • Ssh_user: Your username with which you can log into your private network
  • Ssh_password_secret: The password associated with your username
  • Optional Ssh_port: The Port on which you can connect to your network

Key

After selecting the "Key" in "Select SSH Connection Type" the following fields will appear SSH key file form field The following information will be required from you:

  • Ssh_ip: The public IP address of your private network
  • Ssh_user: Your username with which you can log into your private network
  • Ssh_private_key: Upload field for your key file (Currently supported formats: RSA,Ed25519,ECDSA,DSS)
  • Optional Ssh_port: The Port on which you can connect to your network

Step 2: Testing and Saving Connection

After we have filled all required information in, we can test whether all the information provided is correct by clicking on the "Test Connection" button. If the test is successful, we can click on "Create" and save the connection. If the saving was successful a green checkmark will appear. Afterward, we can see in our data source overview the new database. Testing a newly created connection

On this page

View on GitHub
Soon