Environment Variables

DocPlatform reads configuration from environment variables only — there is no config file. Set them in your shell, your systemd unit, or your container orchestrator.

Server

Variable	Default	Description
`PORT`	`3000`	HTTP listen port
`DATA_DIR`	`.docplatform`	Root directory for all DocPlatform data (database, backups, workspaces, keys)
`DOCPLATFORM_ENV`	—	Set to `production` to enable strict configuration validation (e.g., requires `API_KEY_PEPPER`, blocks `DEV_FRONTEND_URL`)
`BASE_URL`	`http://localhost:{PORT}`	Public URL used for OIDC callbacks, invitation links, and email templates. Set to your production URL (e.g., `https://docs.example.com`).
`BASE_DOMAIN`	—	Custom domain for published docs (e.g., `docs.yourcompany.com`). When set, published docs use this domain for canonical URLs and sitemap entries.
`PUBLISH_REQUIRE_AUTH`	`false`	When `true`, all published documentation sites require the visitor to be logged in as a workspace member. Unauthenticated visitors are redirected to the login page and returned to the original page after sign-in.
`CORS_ORIGINS`	—	Comma-separated list of allowed CORS origins. Leave empty for same-origin only.

Authentication

Variable	Default	Description
`JWT_KEY_PATH`	`{DATA_DIR}/jwt-private.pem`	Path to the RS256 private key for JWT signing. Auto-generated on first run if missing (2048-bit RSA).
`ARGON2_MEMORY`	`65536`	Argon2id memory parameter in KiB (default: 64 MB)
`ARGON2_TIME`	`3`	Argon2id iteration count
`ARGON2_THREADS`	`2`	Argon2id parallelism

Token lifetimes are fixed: access tokens live 15 minutes, refresh tokens 7 days (with single-use rotation). They are not configurable via environment variables.

OIDC providers (optional)

Enable Google and/or GitHub sign-in by setting these variables. When unset, only local authentication (email + password) is available.

Variable	Default	Description
`OIDC_GOOGLE_CLIENT_ID`	—	Google OAuth 2.0 client ID
`OIDC_GOOGLE_CLIENT_SECRET`	—	Google OAuth 2.0 client secret
`OIDC_GITHUB_CLIENT_ID`	—	GitHub OAuth client ID
`OIDC_GITHUB_CLIENT_SECRET`	—	GitHub OAuth client secret

See Authentication for setup instructions.

WebAuthn / Passkeys (optional)

Enable passwordless authentication with hardware security keys or biometrics. Disabled when WEBAUTHN_RP_ID is not set.

Variable	Default	Description
`WEBAUTHN_RP_ID`	—	Relying Party ID — your domain name (e.g., `docs.example.com`). Required to enable WebAuthn.
`WEBAUTHN_RP_DISPLAY_NAME`	`DocPlatform`	Display name shown in browser passkey prompts.
`WEBAUTHN_RP_ORIGINS`	—	Comma-separated list of allowed origins for WebAuthn ceremonies (e.g., `https://docs.example.com`).

See Authentication for setup instructions.

Git

Variable	Default	Description
`GIT_SSH_KEY_PATH`	`~/.ssh/docplatform_deploy_key`	Path to the SSH private key for git operations. Required for private repos over SSH.
`GIT_SSH_KNOWN_HOSTS`	—	Path to known_hosts file for strict host verification. If not set, uses built-in pinned keys for GitHub, GitLab, and Bitbucket.
`GIT_SYNC_INTERVAL`	`300`	Default polling interval in seconds for remote sync (minimum: 10). Overridden by per-workspace `sync_interval`.
`GIT_AUTO_COMMIT`	`true`	Default auto-commit behavior. Overridden by per-workspace `git_auto_commit`.
`GIT_ENCRYPTION_KEY`	—	Master key (minimum 16 characters) used to encrypt git provider tokens at rest (AES-256-GCM with Argon2id key derivation). Required to connect git providers with a personal access token.
`GIT_ALLOWLIST_PRIVATE`	`false`	Community Edition: set to `true` to allow private git remote URLs.

Incoming git webhooks are verified with a per-workspace secret that DocPlatform generates automatically (32-byte random hex) — find it in Workspace Settings → Git. There is no global webhook secret variable. Commits from editor saves carry the acting user’s identity as the git author; automatic conflict-merge commits are authored as [email protected].

Email (optional)

Configure SMTP or Resend for workspace invitations and password reset emails. Without email configured, these emails are simply not sent and tokens are not logged — use docplatform reset-password to generate reset links on the server.

Variable	Default	Description
`SMTP_HOST`	—	SMTP server hostname (e.g., `smtp.gmail.com`)
`SMTP_PORT`	`587`	SMTP port (587 for STARTTLS, 465 for SSL)
`SMTP_FROM`	—	Sender email address (e.g., `[email protected]`)
`SMTP_USERNAME`	—	SMTP authentication username
`SMTP_PASSWORD`	—	SMTP authentication password
`RESEND_API_KEY`	—	Resend API key. When set alongside SMTP, Resend is preferred.
`RESEND_FROM`	—	Sender email for Resend (e.g., `[email protected]`)

Backups

Variable	Default	Description
`BACKUP_ENABLED`	`true`	Enable daily automated SQLite backups
`BACKUP_RETENTION_DAYS`	`7`	Number of days to retain backup files. Older backups are deleted automatically.

Backups are always written to {DATA_DIR}/backups/ — the location is not separately configurable.

Telemetry

Variable	Default	Description
`DOCPLATFORM_TELEMETRY`	`off`	Set to `on` to enable anonymous, opt-in usage metrics. When enabled, a SHA-256 install ID (no personally identifiable information) is sent weekly.
`DOCPLATFORM_TELEMETRY_ENDPOINT`	—	Custom endpoint for telemetry data (advanced — for air-gapped environments with internal analytics)

What telemetry sends (when enabled)

SHA-256 install ID (derived from data directory, not reversible)
Workspace count and total page count
DocPlatform version
OS and architecture

Telemetry never sends: page content, user emails, IP addresses, file names, or any personally identifiable information. Frequency: weekly.

Stripe billing (Cloud edition only)

These variables exist only in the Cloud edition that powers app.valoryx.dev. The Community Edition binary contains no billing code at all — these variables have no effect on a self-hosted install, and every Community organization is unlimited by design.

When STRIPE_SECRET_KEY is not set, billing is disabled and all organizations are treated as unlimited.

Variable	Default	Description
`STRIPE_SECRET_KEY`	—	Stripe secret API key (starts with `sk_test_` or `sk_live_`)
`STRIPE_WEBHOOK_SECRET`	—	Stripe webhook endpoint signing secret (starts with `whsec_`)
`STRIPE_PRICE_TEAM`	—	Stripe Price ID for Team plan monthly ($29/mo)
`STRIPE_PRICE_BUSINESS`	—	Stripe Price ID for Business plan monthly ($79/mo)
`STRIPE_PRICE_TEAM_ANNUAL`	—	Stripe Price ID for Team plan annual ($290/yr)
`STRIPE_PRICE_BUSINESS_ANNUAL`	—	Stripe Price ID for Business plan annual ($790/yr)
`TRIAL_DURATION_DAYS`	`14`	Number of free trial days for new paid subscriptions
`FF_BILLING`	`true`	Master billing switch. Set to `false` to disable billing entirely and treat all orgs as unlimited.

Custom domains

Configure Caddy integration for automatic TLS provisioning on custom domains.

Variable	Default	Description
`CADDY_ADMIN_URL`	`http://localhost:2019`	Caddy admin API URL for dynamic TLS provisioning
`CADDY_ASK_SECRET`	—	Shared secret for the `/internal/caddy/ask` endpoint. Required for custom domain TLS — empty rejects all TLS requests.

API security

Variable	Default	Description
`API_KEY_PEPPER`	—	HMAC pepper for API key hashing. Required when `DOCPLATFORM_ENV=production`. Can also be set as `DOCPLATFORM_API_KEY_PEPPER`.
`HIDE_STORAGE_PATHS`	`false`	Suppress disk paths in API responses (recommended for cloud/SaaS deployments).
`SHOW_DISK_PATHS_TO_WS_ADMIN`	`false`	Opt-in: show disk paths to workspace admins in storage info responses.

Observability

Variable	Default	Description
`FF_METRICS`	`false`	Enable Prometheus metrics at `/metrics` on the main port (platform-owner authentication required).
`METRICS_PORT`	—	When set, additionally exposes an unauthenticated `/metrics` listener bound to `127.0.0.1:{port}` for local Prometheus scraping.

Updates

Variable	Default	Description
`DISABLE_UPDATE_CHECK`	`false`	Skip the startup check for new DocPlatform versions.

Development

Variable	Default	Description
`DEV_FRONTEND_URL`	—	Proxy non-API requests to this URL for frontend hot module reloading during development. Blocked when `DOCPLATFORM_ENV=production`.

Setting variables for a service

DocPlatform does not read .env files — variables must be present in the process environment. For a systemd deployment, use an EnvironmentFile:

# /etc/systemd/system/docplatform.service (excerpt)
[Service]
EnvironmentFile=/etc/docplatform/env
ExecStart=/usr/local/bin/docplatform serve

# /etc/docplatform/env  (chmod 600)
PORT=8080
DATA_DIR=/var/lib/docplatform
GIT_SSH_KEY_PATH=/etc/docplatform/deploy_key
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_FROM=[email protected]
SMTP_USERNAME=[email protected]
SMTP_PASSWORD=app-specific-password
BACKUP_RETENTION_DAYS=30

Docker environment

Pass environment variables to Docker with -e flags or an env file:

docker run -d \
  --name docplatform \
  -p 3000:3000 \
  -v docplatform-data:/data \
  -e DATA_DIR=/data \
  -e SMTP_HOST=smtp.example.com \
  -e SMTP_FROM=[email protected] \
  --env-file .env.production \
  ghcr.io/valoryx-org/docplatform:latest

Security notes

Never commit .env files to version control. Add .env to your .gitignore.
JWT keys are auto-generated. If you need to rotate, delete the key file and restart — a new key is generated and all existing sessions are invalidated.
SMTP passwords — use app-specific passwords or API keys, not your primary account password.
Git tokens — use repository-scoped tokens with minimal permissions (read + write for sync).