Skip to content

docs: improve PG_URL environment variable documentation #814

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
h3n4l merged 1 commit into from
Aug 13, 2025
Merged

docs: improve PG_URL environment variable documentation #814

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
18 changes: 16 additions & 2 deletions mintlify/get-started/self-host/external-postgres.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,23 @@ Grant the db_owner role to the user:
GRANT db_owner TO bytebase;
```

### PG_URL String Format
### PG_URL Environment Variable

Bytebase uses the standard PostgreSQL connection URI format. See the [official PostgreSQL documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS) for complete details.
The `PG_URL` environment variable configures the PostgreSQL connection for Bytebase. You can set it in two ways:

#### Direct Connection String
Set `PG_URL` directly to a PostgreSQL connection URI:
```bash
PG_URL="postgresql://bytebase:[email protected]:5432/bytebase"
```

#### File Path (Kubernetes & Secret Management)
For Kubernetes deployments and secret manager integration, set `PG_URL` to a file path containing the connection string. Bytebase automatically picks up the updated connection string when the file content changes, enabling seamless secret rotation.
```bash
PG_URL="/path/to/connection/file"
```

The connection string must follow the standard PostgreSQL URI format. See the [official PostgreSQL documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS) for complete syntax details.

**Example:**

Expand Down