Connecting to Neon Databases

Overview

Neon provides fully managed serverless PostgreSQL databases with branching, autoscaling, and bottomless storage. This guide will help you connect your Neon database to Outerbase.


Prerequisites

Before starting, make sure you have already:

  1. Signed up for a Neon account (If you haven't visit www.neon.tech you can start for free!)
  2. Created a postgres database within that account
  3. Set up access the correct access credentials for your Neon database (read-only or read/write)
  4. Created an Outerbase account

Step 1: Obtain Connection Details

  1. Log in to your Neon account.
  2. Navigate to your database instance.
  3. In the "Dashboard" tab, find the Connection Details section.
  4. Copy and paste the connection string (Make sure you click the copy button or open the eye so you copy your password and not a series of asterisks)

OR

You can copy each parameter individually by selecting that from the dropdown next to the connection string. You will need these:

  • Host Name: This is the network address of your Neon Database instance.
  • Port: The port number through which the database listens for connections. (This should be 5432)
  • Username and Password: The credentials for accessing the database.
  • Database Name: The specific database you want to connect to.

Step 2: Connect from Outerbase

With the necessary information in hand, configure your Outerbase application to connect to your Neon Database instance.

  1. Open your Outerbase application's configuration.
  2. Locate the database configuration section.
  3. Enter the Neon Database host name as the database host.
  4. Provide 5432 as the Port number.
  5. Use the username and password you set up for your Neon database.
  6. Specify the database name you want to connect to.
  7. Save the configuration changes.

Step 3 (Optional): Allowlist Outerbase IPs

To further protect your database you can add Outerbase's IP address to your allowed IPs.

  1. Navigate to your Neon database settings
  2. Make sure you have IP Allow enabled (This is a Pro Feature)
  3. Copy these IP addresses: 44.205.184.114 54.172.85.237
  4. Paste them into your Neon database settings.

Conclusion

You have successfully connected your Outerbase application to your Neon database. This integration allows your application to combine Neon's powerful serverless PostgreSQL capabilities, with Outerbase's easy-to-use and manage database GUI.

Remember to keep your credentials and connection details secure and regularly review and update your security settings.

For more detailed guidance and troubleshooting, consult the Neon documentation.