Configuration
Use the source .env.example for the complete comments and defaults. This page identifies the major boundaries and values required by each deployment shape.
Core application
| Variable | Required | Purpose |
|---|---|---|
NUXT_POCKETBASE_URL | Yes | Internal PocketBase origin |
NUXT_POCKETBASE_ADMIN_EMAIL | Yes | Superuser used by both PocketBase boot and web |
NUXT_POCKETBASE_ADMIN_PASSWORD | Yes | Matching generated superuser password |
NUXT_PUBLIC_APP_URL | Yes | Public origin used to build connector URLs |
NUXT_ALLOW_PRIVATE_TARGETS | No | Permit user-supplied private targets in trusted single-tenant installs |
PB_ENCRYPTION_KEY | Recommended | Encrypt sensitive PocketBase settings at rest |
| Variable | Required when enabled | Purpose |
|---|---|---|
EVOLUTION_API_KEY | For bundled Evolution | Global Evolution administrator key |
NUXT_EVOLUTION_URL | For a default server | Evolution origin reached by web |
NUXT_EVOLUTION_ADMIN_KEY | For a default server | Must match EVOLUTION_API_KEY |
NUXT_EVOLUTION_DATABASE_URL | For reads and search | Read-only access to Evolution "Message" |
WEBHOOK_URL | Local compose | Compose fallback webhook URL |
NUXT_WEBHOOK_URL | Yes for fast Evolution alerts | Per-connection webhook registered by web |
NUXT_WEBHOOK_SECRET | Strongly recommended | Shared x-webhook-secret value |
POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB | Local compose | Evolution datastore values |
Set Evolution DATABASE_SAVE_DATA_HISTORIC=true before pairing if full history matters.
Telegram
| Variable | Required when enabled | Purpose |
|---|---|---|
TELEGRAM_API_ID, TELEGRAM_API_HASH | Yes | Credentials from my.telegram.org |
TELEGRAM_BRIDGE_ADMIN_KEY | Yes | Creates and deletes bridge sessions |
TELEGRAM_SESSION_ENCRYPTION_KEY | Yes | Seals stored account sessions |
TELEGRAM_BRIDGE_DATABASE_URL | Yes | Bridge owner connection to Postgres |
NUXT_TELEGRAM_URL | For a default bridge | Bridge origin reached by web |
NUXT_TELEGRAM_ADMIN_KEY | For a default bridge | Matches the bridge administrator key |
NUXT_TELEGRAM_DATABASE_URL | For reads and search | Read access to the telegram schema |
NUXT_TELEGRAM_WEBHOOK_URL | Local development | Bridge-to-web callback; production derives it from app URL |
Backfill is tuned by TELEGRAM_BACKFILL_MAX_PER_CHAT, TELEGRAM_BACKFILL_DAYS, TELEGRAM_BACKFILL_BROADCAST, and TELEGRAM_BACKFILL_PAGE_DELAY_MS.
Alerts and mail
PocketBase sends connection and invitation email. Configure PB_SMTP_HOST, PB_SMTP_PORT, PB_SMTP_USERNAME, PB_SMTP_PASSWORD, PB_SMTP_TLS, PB_SMTP_AUTH_METHOD, PB_SENDER_ADDRESS, and PB_SENDER_NAME.
With PB_SMTP_HOST empty, alerts are computed but delivery fails in a normal container. The sender address must be a valid address accepted by the provider.
Production settings
- Do not ship
.env; use platform variables and secret references. - Set
NUXT_WEBHOOK_SECRET. - Keep
NUXT_ALLOW_PRIVATE_TARGETSunset for shared deployments. - Use a dedicated read-only role for
NUXT_EVOLUTION_DATABASE_URL. - Keep Evolution global keys, bridge keys, database URLs, and PocketBase administrator credentials out of client code and logs.
- Preserve
TELEGRAM_SESSION_ENCRYPTION_KEYoutside the deployment platform.
NUXT_EVOLUTION_ADMIN_KEY can create, inspect, and delete every WhatsApp instance on the default Evolution server. Treat it as one of the highest-impact credentials in the deployment.