---
title: Postgres credentials
contentType:
  - integration
  - reference
priority: high
nodeTitle: Postgres credentials
originalFilePath: integrations/builtin/credentials/postgres.md
originalUrl: https://docs.n8n.io/integrations/builtin/credentials/postgres
url: https://docs.n8n.io/integrations/builtin/credentials/postgres
description: >-
  Documentation for Postgres credentials. Use these credentials to authenticate
  Postgres in n8n, a workflow automation platform.
layout:
  width: default
  title:
    visible: true
  description:
    visible: false
  tableOfContents:
    visible: true
  outline:
    visible: true
  pagination:
    visible: true
  metadata:
    visible: true
  tags:
    visible: true
  actions:
    visible: true
---

# Postgres credentials

You can use these credentials to authenticate the following nodes:

* [Postgres](../app-nodes/n8n-nodes-base.postgres/README.md)
* [Agent](../cluster-nodes/root-nodes/n8n-nodes-langchain.agent/README.md)
* [Postgres Chat Memory](../cluster-nodes/sub-nodes/n8n-nodes-langchain.memorypostgreschat.md)
* [PGVector Vector Store](../cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md)

{% hint style="info" %}
**Agent node users**

The Agent node doesn't support SSH tunnels.
{% endhint %}

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

[Create a user account](https://www.postgresql.org/docs/current/sql-createuser.html) on a Postgres server.

## Supported authentication methods <a href="#supported-authentication-methods" id="supported-authentication-methods"></a>

* Database connection

## Related resources <a href="#related-resources" id="related-resources"></a>

Refer to [Postgres's documentation](https://www.postgresql.org/docs/16/index.html) for more information about the service.

## Using database connection <a href="#using-database-connection" id="using-database-connection"></a>

To configure this credential, you'll need:

* The **Host** or domain name for the server.
* The **Database** name.
* A **User** name.
* A user **Password**.
* **Ignore SSL Issues**: Set whether the credential connects if SSL validation fails.
* **SSL**: Choose whether to use SSL in your connection.
* The **Port** number to use for the connection.
* **SSH Tunnel**: Choose if you want to use SSH to encrypt the network connection with the Postgres server.

To set up the database connection:

1.  Enter the **Host** or domain name for the Postgres server. You can either run the `/conninfo` command to confirm the host name or run this query:

    ```
    SELECT inet_server_addr();
    ```
2. Enter the **Database** name. Run the `/conninfo` command to confirm the database name.
3. Enter the **User** name of the user you wish to connect as.
4. Enter the user's **Password**.
5. **Ignore SSL Issues**: If you turn this on, the credential will connect even if SSL validation fails.
6. **SSL**: Choose whether to use SSL in your connection. Refer to Postgres [SSL Support](https://www.postgresql.org/docs/16/libpq-ssl.html) for more information. Options include:
   * **Allow**: Sets the `ssl-mode` parameter to `allow`. First try a non-SSL connection; if that fails, try an SSL connection.
   * **Disable**: Sets the `ssl-mode` parameter to `disable`. Only try a non-SSL connection.
   * **Require**: Sets the `ssl-mode` parameter to `require`. Only try an SSL connection. If a root CA file is present, verify that a trusted certificate authority (CA) issued the server certificate.
7.  Enter the **Port** number to use for the connection. You can either run the `/conninfo` command to confirm the host name or run this query:

    ```
    SELECT inet_server_port();
    ```
8. **SSH Tunnel**: Turn this setting on to connect to the database over SSH. Refer to [SSH tunnel limitations](postgres.md#ssh-tunnel-limitations) for some guidance around using SSH. Once turned on, you'll need:
   1. Select **SSH Authenticate with** to set the SSH Tunnel type to build:
      * Select **Password** if you want to connect to SSH using a password.
      * Select **Private Key** if you want to connect to SSH using an identity file (private key) and a passphrase.
   2. Enter the remote bind address you're connecting to as the **SSH Host**.
   3. **SSH Port**: Enter the local port number for the SSH tunnel.
   4. **SSH Postgres Port**: Enter the remote end of the tunnel, the port number the database server is using.
   5. **SSH User**: Enter the username to log in as.
   6. If you selected **Password** for SSH Authenticate with, add the user's **SSH Password**.
   7. If you selected **Private Key** for **SSH Authenticate with**:
      1. Add the contents of the **Private Key** or identity file used for SSH.
      2. If the **Private Key** was created with a passphrase, enter that **Passphrase**. If the **Private Ke**y has no passphrase, leave this field blank.

Refer to [Secure TCP/IP Connections with SSH Tunnels](https://www.postgresql.org/docs/16/ssh-tunnels.html) for more information.

### SSH tunnel limitations <a href="#ssh-tunnel-limitations" id="ssh-tunnel-limitations"></a>

Only use the **SSH Tunnel** setting if:

* You're using the credential with the [Postgres](../app-nodes/n8n-nodes-base.postgres/README.md) node (Agent node doesn't support SSH tunnels).
* You have an SSH server running on the same machine as the Postgres server.
* You have a user account that can log in using `ssh`.