Skip to content

Commit f5a7c8d

Browse files
committed
docs: add Environment Variables section to Publisher guide
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>
1 parent dcdbff2 commit f5a7c8d

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

src/documentation/user_guides/publishing/publishing.malloynb

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,19 @@ services:
172172
retries: 3
173173
```
174174

175+
### Environment Variables
176+
177+
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.
178+
179+
| Env var | Default | Meaning |
180+
|---|---|---|
181+
| `PUBLISHER_PORT` | `4000` | REST + static-app HTTP port. |
182+
| `MCP_PORT` | `4040` | MCP HTTP port (for AI agents). |
183+
| `SERVER_ROOT` | `.` (cwd) | Directory containing `publisher.config.json`. |
184+
| `LOG_LEVEL` | `debug` | One of `error`, `warn`, `info`, `verbose`, `debug`, `silly`. |
185+
| `GOOGLE_APPLICATION_CREDENTIALS` | _unset_ | Fallback path to a GCP service-account JSON for BigQuery connections that don't include inline auth. Ignored when the connection config provides its own credentials. |
186+
| `PG_CONNECT_TIMEOUT_SECONDS` | `5` | Connection timeout (seconds) for Postgres-backed DuckLake manifest catalogs (`materializationStorage`). Bad credentials or an unreachable host return HTTP 422 in ~5s rather than hanging the publisher. No effect on user-facing Postgres connections or non-PG catalogs (SQLite, MySQL). |
187+
175188
---
176189

177190
## Verify It Works

0 commit comments

Comments
 (0)