Skip to content

docs: add Environment Variables section to Publisher guide #316

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
mlennie wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Environment Variables section to Publisher guide #316

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
13 changes: 13 additions & 0 deletions src/documentation/user_guides/publishing/publishing.malloynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,19 @@ services:
retries: 3
```

### Environment Variables

Publisher reads runtime settings from environment variables. The most common ones are below; see the [Publisher README](https://github.com/malloydata/publisher#configuration) for the full list and matching CLI flags.

| Env var | Default | Meaning |
|---|---|---|
| `PUBLISHER_PORT` | `4000` | REST + static-app HTTP port. |
| `MCP_PORT` | `4040` | MCP HTTP port (for AI agents). |
| `SERVER_ROOT` | `.` (cwd) | Directory containing `publisher.config.json`. |
| `LOG_LEVEL` | `debug` | One of `error`, `warn`, `info`, `verbose`, `debug`, `silly`. |
| `GOOGLE_APPLICATION_CREDENTIALS` | _unset_ | Path to a GCP service-account JSON. Required for BigQuery connections. |
Copy link
Copy Markdown

@sagarswamirao sagarswamirao May 15, 2026

Choose a reason for hiding this comment

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

The BigqueryConnection uses this as the fallback only when the connection object is {}

| `PG_CONNECT_TIMEOUT_SECONDS` | `5` | libpq `connect_timeout` (seconds) for Postgres-backed DuckLake manifest catalogs (`materializationStorage`). Bad credentials or an unreachable host return HTTP 422 in ~5s rather than hanging the worker. libpq enforces a 2-second floor. No effect on user-facing Postgres connections or non-PG catalogs (SQLite, MySQL). |
Copy link
Copy Markdown

@sagarswamirao sagarswamirao May 15, 2026

Choose a reason for hiding this comment

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

Replace the word worker with either publisher or server

I'm a bit confused. libpq has a 2 second floor but the default value we set to is 5? I think we should remove description about libpq


---

## Verify It Works
Expand Down