docs: add Environment Variables section to Publisher guide#316
Open
mlennie wants to merge 1 commit into
Open
Conversation
Adds an Environment Variables subsection under Deployment & Configuration in publishing.malloynb. Covers the most common runtime vars (PUBLISHER_PORT, MCP_PORT, SERVER_ROOT, LOG_LEVEL, GOOGLE_APPLICATION_CREDENTIALS) and the newly introduced PG_CONNECT_TIMEOUT_SECONDS, with a link to the publisher README for the full list and matching CLI flags. PG_CONNECT_TIMEOUT_SECONDS was added in malloydata/publisher#741 to bound the libpq handshake on Postgres-backed DuckLake manifest catalogs. Signed-off-by: Monty Lennie <montylennie@gmail.com>
| | `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. | |
There was a problem hiding this comment.
The BigqueryConnection uses this as the fallback only when the connection object is {}
| | `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. | | ||
| | `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). | |
There was a problem hiding this comment.
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
sagarswamirao
suggested changes
May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an Environment Variables subsection under Deployment & Configuration in publishing.malloynb. Covers the most common runtime vars (PUBLISHER_PORT, MCP_PORT, SERVER_ROOT, LOG_LEVEL, GOOGLE_APPLICATION_CREDENTIALS) and the newly introduced PG_CONNECT_TIMEOUT_SECONDS, with a link to the publisher README for the full list and matching CLI flags.
PG_CONNECT_TIMEOUT_SECONDS was added in
malloydata/publisher#741 to bound the libpq handshake on Postgres-backed DuckLake manifest catalogs.