Skip to content

add docs for SSL configuration #195

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

Merged
pfent merged 1 commit into from
Aug 14, 2026
+18 −1
Merged

add docs for SSL configuration #195

Show file tree
Hide file tree
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 content/references/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,23 @@ ALTER SYSTEM SET buffersize = '8G';

As with the config file, these changes only take effect after a restart.

## SSL configuration

CedarDB supports encrypted client/server connections by default.
The standard configuration sets up SSL / TLS with a self-signed certificate.
The key material is stored in the database directory as `server.key` and `server.crt`.

```shell
# Regular SSL mode works out of the box
psql 'postgresql://postgres@localhost:5432/postgres?sslmode=require'
```

Certificate verification needs either a signature by a public CA, or connections need to specify `sslrootcert` explicitly:

```shell
psql 'postgresql://postgres@localhost:5432/postgres?sslmode=verify-ca&sslrootcert=/path/to/server.crt'
```

## Logging

CedarDB prints log messages to the standard error output stream (stderr, fd 2).
Expand Down
2 changes: 1 addition & 1 deletion data/releasenotes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
},
{
"type": "pg",
"note": "Switch to PostgreSQL compatible <tt>ssl_key_file</tt> and <tt>ssl_cert_file</tt> configuration parameters. Please consult our documentation on how to configure SSL."
"note": "Switch to PostgreSQL compatible <tt>ssl_key_file</tt> and <tt>ssl_cert_file</tt> configuration parameters. Please consult <a href=https://cedardb.com/docs/references/configuration/#ssl-configuration>our documentation</a> on how to configure SSL."
},
{
"type": "pg",
Expand Down
Loading