PostgreSQL Pgpass

Overview

CloudBeaver is fully compatible with the PgPass authentication method, offering a secure way to access your PostgreSQL databases.

Note

Only an admin can create a PgPass connection.

Settings

PostgreSQL's PgPass method allows authentication using credentials stored in a .pgpass file. Follow the steps below to configure it in CloudBeaver.

Server configuration

1. Create the .pgpass file. Each line in the file follows the format:

   hostname:port:database:username:password
   

   Save this line in the .pgpass file and ensure the file permissions are set to be readable only by the user.

   Info

   For more information on .pgpass, see PostgreSQL documentation.

2. Open a terminal and run the following command to list Docker containers:

   docker ps
   

3. Copy the ID of the CloudBeaver container from the list.

4. Transfer the .pgpass file to the container:

   • For versions before 24.3.4:

     docker cp .pgpass "<container-id>":/root/.pgpass
     docker exec "<container-id>" chmod 600 /root/.pgpass
     

   • Starting from version 24.3.4:

     docker cp .pgpass "<container-id>":/opt/cloudbeaver/.pgpass
     docker exec "<container-id>" chmod 600 /opt/cloudbeaver/.pgpass
     

     Note

     Ensure the .pgpass file is placed in the correct directory based on your CloudBeaver version.

Create connection

After transferring the .pgpass file to the container, follow these steps to finalize the configuration:

1. Open CloudBeaver and start creating a connection.
2. In the Authentication dropdown menu, select PostgreSQL PgPass.
3. Enter the username associated with the PostgreSQL database in the Username field.
4. Test the connection by clicking the Test button. If the .pgpass file is properly configured and the credentials are correct, CloudBeaver will connect successfully.