Skip to content

docs: show working connectionString and custom CA configuration #3862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fardeen-coder666 wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −0
Open

docs: show working connectionString and custom CA configuration #3862

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/pages/features/ssl.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,23 @@ const config = {
}
```

To keep the CA certificate in the `ssl` object, use a connection string without those SSL query parameters:

```js
import fs from 'node:fs'
import { Pool } from 'pg'

const pool = new Pool({
connectionString: 'postgres://user:password@localhost:5432/db?application_name=example',
ssl: {
ca: fs.readFileSync('/path/to/server-certificates/root.crt'),
rejectUnauthorized: true,

@charmander charmander Nov 13, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default

Suggested change
rejectUnauthorized: true,

},
})
```

Here TLS is enabled by the `ssl` object, and the server certificate is verified against the supplied CA. Other query parameters, such as `application_name`, can remain in the connection string. If your provider supplies a URL containing SSL parameters, remove those parameters before using this configuration and keep all required TLS settings in the `ssl` object.

## Direct SSL negotiation

By default node-postgres uses the traditional PostgreSQL SSL negotiation: it sends an `SSLRequest` packet, waits for the server to acknowledge it, and only then starts the TLS handshake. PostgreSQL 17 and newer also support _direct_ SSL negotiation, where the TLS handshake begins immediately on connect (similar to HTTPS), saving one network round-trip.
Expand Down
Loading