PostgreSQL Connection

Learn how to configure a PostgreSQL Connection for Infisical.

Infisical supports connecting to PostgreSQL using a database role.

Configure a PostgreSQL Role for Infisical

1. Create a Role

   Infisical recommends creating a designated role in your PostgreSQL database for your connection.

   -- create user role
   CREATE ROLE infisical_role WITH LOGIN PASSWORD 'my-password';
   
   -- grant login access to the specified database
   GRANT CONNECT ON DATABASE my_database TO infisical_role;
   

2. Grant Relevant Permissions

   Depending on how you intend to use your PostgreSQL connection, you’ll need to grant one or more of the following permissions.

   To learn more about PostgreSQL’s permission system, please visit their documentation.

   Secret Rotation

   For Secret Rotations, your Infisical user will require the ability to alter other users’ passwords:

   -- enable permissions to alter login credentials
   ALTER ROLE infisical_role WITH CREATEROLE;
   

   In some configurations, the role performing the rotation must be explicitly granted access to manage each user. To do this, grant the user’s role to the rotation role with:

   -- grant each user role to admin user for password rotation
   GRANT <secret_rotation_user> TO <infisical_role> WITH ADMIN OPTION;
   

   Replace <secret_rotation_user> with each specific username whose credentials will be rotated, and <infisical_role> with the role that will perform the rotation.

3. Get Connection Details

   You’ll need the following information to create your PostgreSQL connection:

   • host - The hostname or IP address of your PostgreSQL server
   • port - The port number your PostgreSQL server is listening on (default: 5432)
   • database - The name of the specific database you want to connect to
   • username - The role name of the login created in the steps above
   • password - The role password of the login created in the steps above
   • sslCertificate (optional) - The SSL certificate required for connection (if configured)

   If you are self-hosting Infisical and intend to connect to an internal/private IP address, be sure to set the ALLOW_INTERNAL_IP_CONNECTIONS environment variable to true.

Create Connection in Infisical

Infisical UI

1. Navigate to the App Connections tab on the Organization Settings page.

2. Select the PostgreSQL Connection option.

3. Select the Username & Password method option and provide the details obtained from the previous section and press Connect to PostgreSQL.

Optionally, if you’d like Infisical to manage the credentials of this connection, you can enable the Platform Managed Credentials option. If enabled, Infisical will update the password of the connection on creation to prevent external access to this database role.

4. Your PostgreSQL Connection is now available for use.