Self-hosting
Configuration
Every environment variable Vigie reads, with its default.
On a server, set these in deploy/.env and run deploy/install.sh again: every variable there reaches Vigie. On your machine, set them in the shell that runs bunx vigie.
Core
| Variable | Default | What it does |
|---|---|---|
VIGIE_MODE | local | server turns on sign-in, keys and monitors. The Docker image sets it. |
VIGIE_PUBLIC_URL | http://localhost:4310 | The address people and apps use. Links in alerts point here. |
VIGIE_DEFINITIONS | ./definitions | The folder of your definitions. |
VIGIE_ENVS | DEV locally, PRD,STG on a server | Environments this Vigie keeps. Anything else lands in the last one, never in production. |
VIGIE_DATA_DIR | ~/.vigie, /data on a server | Where SQLite state and the spool live. |
VIGIE_UI_PORT, VIGIE_INGEST_PORT | 4310, 4318 | The app and OTLP ports. |
CLICKHOUSE_URL, CLICKHOUSE_USER, CLICKHOUSE_PASSWORD, CLICKHOUSE_DATABASE | http://127.0.0.1:8123, default, empty, vigie | Where telemetry is stored. |
VIGIE_TASK_METRICS | vigie.tasks | Prefix of the two task gauges. |
Your app
| Variable | What it does |
|---|---|
VIGIE_APP_NAME | Your app's name, as shown in buttons and messages. |
VIGIE_APP_URL | Your app's address, for "open in app" links. |
VIGIE_APP_API_URL | Your app's API. Task actions (requeue, cancel, run now) call it as the signed-in person. |
VIGIE_APP_DATABASE_URL | A read-only Postgres role (see deploy/app-readonly.sql), for the Database screen and queued tasks. Vigie refuses raw SQL if the role can read credentials. |
VIGIE_SOURCE_REPO, VIGIE_GITHUB_TOKEN | owner/repo, to show the source behind stack frames. |
Notifications
| Variable | What it does |
|---|---|
VIGIE_SLACK_WEBHOOK | A Slack channel, without going through Settings. |
VIGIE_SMTP_URL, VIGIE_MAIL_FROM | Email alerts. |
VIGIE_ALERT_GROUP_MS | Alerts within this window go out as one message. 30 s by default. |
VIGIE_LINEAR_API_KEY, VIGIE_LINEAR_TEAM_ID | Create Linear issue on issues. |
Sign-in
| Variable | What it does |
|---|---|
BETTER_AUTH_SECRET | Signs sessions. deploy/install.sh generates it. |
VIGIE_OIDC_ISSUER, VIGIE_OIDC_CLIENT_ID, VIGIE_OIDC_CLIENT_SECRET, VIGIE_OIDC_NAME | Single sign-on with any OpenID Connect provider. |
VIGIE_ALLOW_SIGNUP | true lets anyone with the address create an account. Off by default. |
AI
| Variable | What it does |
|---|---|
VIGIE_AI_API_KEY | Turns on Ask Vigie, explain and search in words. |
VIGIE_AI_BASE_URL | Any OpenAI-compatible provider. |
VIGIE_AI_MODEL | gpt-4.1-mini by default. |