# Environment variables

**For:** self-hosters setting up or tuning a server. **At the end:** you know every setting, which program reads it, its default and an example value.

<!-- Generated by tools/manual/generate.py from tools/manual/env.toml and a scan of the code. Edit the source, then run `uv run python tools/manual/generate.py`. tests/test_manual.py fails while this is stale. -->

Every program is one command of the same image: `wow-stats ui`, `publish`, `static`, `exporter`, `render`, `users`. The compose kit (`deploy/compose`) sets most of these for you: in `.env` you only set what its comments name. "Read by" says which command reads a variable; `compose` means only `docker compose` reads it, from `.env`.

A variable ending in `_FILE` names a file that holds the value (a secret, a key). Prefer it to the plain form: a file doesn't show up in `docker inspect` or a process list.

## The page (`wow-stats ui`)

The live full view, and the old live public view.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `ALLOWED_HOSTS` | ui | host names, comma separated | empty: localhost, IP addresses and the hosts of `PUBLIC_URL` and `MCP_PUBLIC_URL` only | `nas.local,wow-full.example.org` | More names the page answers for. Any other `Host` gets 421, so a web page can't read yours through your browser. A name here means a proxy or another computer in front, so the full view with `AUTH=open` refuses to start with it: set a login (`AUTH=basic` or `AUTH=proxy`). In the compose kit: `UI_ALLOWED_HOSTS` (and `PUBLIC_ALLOWED_HOSTS` for the public view). |
| `ALLOW_OPEN` | ui | `1` or empty | empty | `1` | Lets `AUTH=open` listen beyond loopback: everyone who reaches the port gets in. Only for a public view. In the compose kit: `PUBLIC_ALLOW_OPEN`. |
| `AUTH` | ui | `none`, `open`, `proxy` or `basic` | `none` on a loopback `BIND`, else required | `proxy` | The page's login. `none`: loopback only. `open`: no login, on purpose. `proxy`: a reverse proxy in front logs people in. `basic`: HTTP basic auth. |
| `BASIC_AUTH_PASSWORD` | ui | secret, 12+ characters | empty | a long random string | The password for `AUTH=basic`. Prefer `BASIC_AUTH_PASSWORD_FILE`. |
| `BASIC_AUTH_PASSWORD_FILE` | ui | path | empty | `/run/secrets/basic_password` | A file holding the `AUTH=basic` password. Wins over `BASIC_AUTH_PASSWORD`. |
| `BASIC_AUTH_USER` | ui | text | empty | `me` | The user name for `AUTH=basic`. |
| `BIND` | ui, static, render | address | `0.0.0.0` in the image, `127.0.0.1` outside it | `127.0.0.1` | The address the server listens on. |
| `CACHE_TTL` | ui, publish | seconds | `45` | `45` | How long an answer worked out when asked stays in memory. A plain open of the page gets the answers built in the background once per new data instead. |
| `DEFAULT_CHAR` | ui, publish | `Name-Surname` | empty: the character seen last | `Testchar-Demo` | The character the page and the MCP tools open on. |
| `FULL_DOOR_PATH` | ui | path | `/full/` | empty | The login door of the full view on a shared host: it answers with a redirect to `/`. Empty turns it off, for a full view on its own host. |
| `PORT` | ui, static, render | port | `8080` (`8083` for `render`) | `8080` | The port the server listens on. |
| `PRICE_DAYS` | ui, publish | days | `90` | `30` | Days of Auctionator scans in the prices panel. |
| `PROXY_SECRET_FILE` | ui | path | empty | `/run/secrets/proxy_secret` | With `AUTH=proxy`: a file holding a secret of 32 characters or more that the proxy sends in `PROXY_SECRET_HEADER` on every request. |
| `PROXY_SECRET_HEADER` | ui | header name | `X-Proxy-Auth` | `X-Proxy-Auth` | The header that carries `PROXY_SECRET_FILE`'s secret. |
| `PROXY_TRUSTED_CIDRS` | ui | addresses or CIDRs, comma separated | empty | `192.0.2.10/32` | With `AUTH=proxy`: the login proxy's addresses as this server sees them. Requests from elsewhere don't get their identity header read. This or `PROXY_SECRET_FILE` (or both) is required. |
| `PUBLISHED_ON` | ui | address:port | empty | `127.0.0.1:8080` | Where the container's port is published on the host. A loopback address lets `AUTH=open` run inside the container. The compose kit sets it from `UI_PUBLISH` and `PUBLIC_PUBLISH`. |
| `RENDER_FROM` | ui | URL | empty: from Blizzard's render host | `http://site:8080` | Where the full view gets a character's armory picture. Set it to the static site's address on a server with no route to Blizzard. |
| `VIEW` | ui | `full` or `public` | `full` on a loopback `BIND`, else required | `public` | Which view this process serves. One process serves one view, so a routing mistake can't hand the full view to an outsider. |
| `WEIGHTS` | ui, publish | comma list of `Name-Surname:spec` | empty: what the addons say | `Testchar-Demo:shadow` | The spec each character's gear is scored for. The page's own selector still wins. |
| `WOW_TIMEZONE` | ui, publish | IANA timezone | `Europe/Brussels` | `America/New_York` | The player's timezone, for the hours and weekdays the analysis reads. |

## Uploads from the shipper

`POST /ingest`, on the full view's port.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `INGEST_DAILY_MB` | ui | megabytes | `512` | `1024` | On a shared install, how much each person may upload per UTC day. `0`: no limit. |
| `INGEST_PASSWORD` | ui, compose | secret, 12+ characters | empty: no `/ingest` | a long random string | Turns on `POST /ingest`, where the shipper sends events, with this password. Required by the compose kit. |
| `INGEST_PASSWORD_FILE` | ui | path | empty | `/run/secrets/ingest_password` | A file holding the ingest password. Wins over `INGEST_PASSWORD`. |
| `INGEST_USER` | ui | text | `wow` | `wow` | The user name the shipper sends with the ingest password. |

## The stores

Where the events and the Battle.net data live.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `LOGS_FILTER` | ui, publish | LogsQL filter | `feed:wow-*` | `feed:wow-* site:home` | Selects the game events in VictoriaLogs. Add your own labels here. |
| `VL_ACCOUNT_ID` | ui, publish | whole number | `0` | `0` | The VictoriaLogs tenant to read. Set per person by a shared install; leave it alone otherwise. |
| `VL_ARCHIVE_AFTER_DAYS` | ui, publish | days | `89` | `89` | With `VL_ARCHIVE_URL`: days older than this are read from the archive. |
| `VL_ARCHIVE_URL` | ui, publish | URL | empty: one store holds everything | `http://vl-archive:9428` | A second VictoriaLogs for days older than `VL_ARCHIVE_AFTER_DAYS`. |
| `VL_CONCURRENCY` | ui, publish | number | `2` | `2` | VictoriaLogs requests this process runs at once, all callers together. |
| `VL_URL` | ui, publish | URL | `http://victorialogs:9428` | `http://victorialogs:9428` | The VictoriaLogs that holds the game events. Keep it private: only `ui` and `publish` talk to it. |
| `VM_URL` | ui, publish, compose | URL | empty: no Battle.net data | `http://victoriametrics:8428` | The VictoriaMetrics the exporter pushes to. The public view reads only the character profile from it, never market data. |

## Game data and the 3D view

What the servers download, and the bundled reference data.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `GEAR_REFERENCE_FILE` | ui, publish | path or `off` | the bundled Polestar gear data | `off` | Another gear data file, or `off` to turn gear advice off. |
| `KB_GAME_TABLES` | ui, publish | `on` or `off` | `on` | `off` | The knowledge base's spell and zone documents from Forever's tables. |
| `MODEL3D` | ui, publish, compose | `on` or `off` | `on` | `off` | The "View in 3D" toggle and its downloads from Wowhead's model host. `off` removes it. |
| `MODEL3D_CACHE_DIR` | ui, publish | path | a folder under the temp dir | `/data/model3d-cache` | Where downloaded game tables, icons and model files are kept. Put it on a volume so a restart doesn't download them again. |
| `MODEL3D_CACHE_MB` | ui, publish | MiB | `512` | `256` | The most disk the model files may take. |
| `MODEL3D_MODELS` | ui, publish | `hd` or `sd` | `hd` | `sd` | The models the 3D view opens on: `hd` the updated ones, `sd` the original (Classic) ones. A visitor's own pick in the view wins. With several people, each one's Settings choice replaces it. |
| `MODEL3D_VIEWER_SHA256` | ui, publish, render | sha256 (hex) | the build reviewed on 2026-11-19 | `ce4ceffb…cdd241` | The only build of Wowhead's 3D viewer script the server passes on. When Wowhead ships another, the log says "Wowhead's viewer changed", the last good copy keeps working, and a fresh cache shows no 3D until someone reads the new script and sets its hash here. |
| `ROUTE_REFERENCE_FILE` | ui, publish | path or `off` | the bundled Polestar route times | `off` | Another route times file, or `off` to compare levels with your own past levels only. |
| `WOW_ITEMS` | ui, publish, compose | `on` or `off` | `on` | `off` | Item names, icons and tooltip cards from Forever's tables on wago.tools. `off` with `MODEL3D=off` is the small preset: no downloads at all. |
| `WOW_TALENTS` | ui, publish | `on` or `off` | `on` (`off` when `WOW_ITEMS=off`) | `off` | Talent names and icons from Forever's tables. |

## The MCP endpoint and its login

For your AI assistant. Off until `MCP_PUBLIC_URL` is set. [Connect your AI](https://sam-dumont.github.io/wow-mcp/ai/connect/) and [Set up a login](https://sam-dumont.github.io/wow-mcp/self-host/oidc/) use them.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `MCP_ALLOWED_ORIGINS` | ui | comma list of origins | empty | `https://inspector.example.org` | Extra browser origins allowed to call `/mcp`. |
| `MCP_AUTH` | ui | `oauth` or `none` | `oauth` | `none` | `none` (no login) only works on a loopback `BIND`. |
| `MCP_CIMD_HOSTS` | ui | comma list of hosts | Claude, ChatGPT/Codex, opencode, VS Code, Copilot CLI, Zed, Goose | `claude.ai` | Replaces the list of hosts whose client documents (a URL as client id) are fetched. |
| `MCP_LOGIN` | ui | `oidc` | `oidc` | `oidc` | The only value. The old `password` login is gone: the server refuses to start with it. |
| `MCP_PORT` | ui | port | `8090` | `8090` | The MCP endpoint's own port, on `BIND`. `/mcp` and the login paths are served there, never on `PORT`. |
| `MCP_PUBLIC_URL` | ui, publish, compose | https URL ending in `/mcp` | empty: no MCP endpoint | `https://wow.example.org/mcp` | Turns on the MCP endpoint (full view only) and names the address clients use. The help page shows it too. |
| `MCP_REDIRECT_URIS` | ui | comma list of URLs | the web callbacks of claude.ai, ChatGPT, VS Code and Cursor, plus loopback | `https://claude.ai/api/mcp/auth_callback` | Replaces the list of redirects a registering client may use. |
| `MCP_SIGNING_KEY_FILE` | ui, compose | path, 32+ random bytes | empty: a random key per start | `/run/wow-secrets/mcp_signing_key` | Signs the MCP tokens and encrypts the stored logins. Without it, every restart logs every client out. |
| `MCP_STATE_DIR` | ui | path | empty: memory only | `/data/mcp` | Keeps client registrations and logins (encrypted) across restarts. |
| `OIDC_ALLOWED_ORGS` | ui | comma list | empty | `28437001` | One-person install: the organisation ids allowed, read from `OIDC_ORG_CLAIM`. |
| `OIDC_ALLOWED_SUBS` | ui, compose | comma list | empty | `3f2c9a10-...` | The account ids (`sub` claim) allowed in. Required on a one-person install. |
| `OIDC_CLIENT_ID` | ui, compose | text | empty | `wow-mcp` | The app's client id at your identity provider. |
| `OIDC_CLIENT_SECRET` | ui | secret | empty | use the `_FILE` form | The client secret itself, when `OIDC_CLIENT_SECRET_FILE` isn't set. Prefer the file. |
| `OIDC_CLIENT_SECRET_FILE` | ui, compose | path | `/run/wow-secrets/oidc_client_secret` in the compose kit | `/run/wow-secrets/oidc_client_secret` | A file holding the app's client secret. |
| `OIDC_ISSUER` | ui, compose | https URL | empty | `https://id.example.org/realms/wow` | Your identity provider (its discovery document lives under this address). Required with `MCP_PUBLIC_URL`. |
| `OIDC_ORG_CLAIM` | ui | claim name | ZITADEL's org id claim | `org_id` | The claim that holds the organisation id. Set your provider's. |
| `OIDC_REQUIRED_ROLE` | ui | text | empty | `wow` | One-person install: a role the account must have, read from `OIDC_ROLES_CLAIM`. Removing it ends the login at the next refresh. |
| `OIDC_ROLES_CLAIM` | ui | claim name | ZITADEL's project roles claim | `roles` | The claim that holds the roles. Set your provider's. |
| `OIDC_SCOPES` | ui | space-separated scopes | `openid offline_access` (plus the org scope with `OIDC_ALLOWED_ORGS`) | `openid offline_access` | What the app asks the provider for. |

## The play analysis and plans

Kept per character, judged by the server.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `ANALYSIS_HOUR` | ui | hour, 0 to 23 | `4` | `4` | The local hour of the nightly recheck of kept findings. |
| `ANALYSIS_SHARE_BIND` | ui | address | `BIND`, else `127.0.0.1` | `0.0.0.0` | The address the share port listens on. |
| `ANALYSIS_SHARE_PORT` | ui | port | empty: off | `8091` | A bare listener that hands the screened analysis lines to the publisher. Never route it from outside. |
| `ANALYSIS_SHARE_TOKEN_FILE` | ui, publish, exporter | path | empty: `share-token` in the state folder, made on first start | `/data/share-token` | The share port's bearer token. `ui` makes it on first start; `publish` and the exporter read the same file to call the share port. |
| `ANALYSIS_SHARE_URL` | publish | URL | empty: none | `http://ui:8091/analysis.json` | Where the publisher reads those lines, for `/zogzog/`. |
| `ANALYSIS_STATE_DIR` | ui | path | empty: off | `/data/analysis` | Where the play analysis and the session plans are kept (full view only). Put it on a volume. |

## The static sites (`wow-stats publish`, `wow-stats static`)

The public site and the sealed `/zogzog/` site. [Share your page](https://sam-dumont.github.io/wow-mcp/self-host/sharing/).

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `HELP_KEY_FILE` | publish | path | empty: no help page | `/data/help.key` | The friends' help page key (`/help/#<key>`), 43 base64url characters. Never made for you: no file, no page. |
| `HELP_MCP_URL` | publish | URL | `MCP_PUBLIC_URL` | `https://wow.example.org/mcp` | The MCP address the help page shows. |
| `PLAUSIBLE_API` | publish, ui | path | `/api/event` | `/api/event` | The event path on the site's own address. Route it to your Plausible. |
| `PLAUSIBLE_DOMAIN` | publish, ui, compose | domain | empty: no analytics | `wow.example.org` | Your Plausible site: one pageview per page on the static sites and the full view, through your own address, without the `/zogzog/` key. The same value on the publisher and the ui: one Plausible site for every host. |
| `PLAUSIBLE_SCRIPT` | publish, ui | path | `/js/script.js` | `/js/script.js` | The script path on the site's own address. Route it to your Plausible. |
| `PUBLISH_DIR` | publish | path | `/data/site` | `/data/site` | Where builds go; `current` points at the live one. |
| `PUBLISH_INTERVAL` | publish, compose | seconds | `600` | `600` | With `--loop`: how often to check for new events. |
| `PUBLISH_PUSH_TOKEN_FILE` | publish | path | empty | `/run/secrets/upload_token` | The push token, 32+ characters. Same value as the static server's `UPLOAD_TOKEN_FILE`. |
| `PUBLISH_PUSH_URL` | publish | URL | empty: share a volume | `http://site-upload:8099` | Push each build to a static server's upload port instead of sharing a volume. |
| `SITE_DIR` | static | path | `/data/site` | `/data/site` | What the static server serves: the publisher's `PUBLISH_DIR`. |
| `UPLOAD_PORT` | static | port | `0`: off | `8099` | The push listener. Never route it from outside. |
| `UPLOAD_TOKEN_FILE` | static | path | empty | `/run/secrets/upload_token` | The token a push must carry, 32+ characters. |
| `ZOGZOG_KEY_FILE` | publish, ui | path | `zogzog.key` next to `PUBLISH_DIR` | `/data/zogzog.key` | The sealed site's key, 43 base64url characters. Made (mode 0600) when missing. |
| `ZOGZOG_LINK_BASE` | publish | URL | empty | `https://wow.example.org` | The site's address, for the link `zogzog-key link` prints. |
| `ZOGZOG_PATH` | ui, publish, static, compose | path | `/zogzog/` | empty | The sealed site's path. Set and empty: no sealed site is built or served. |

## Past levels' pictures (`wow-stats render`)

Optional. A separate image with Chromium.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `RENDER_BUDGET_S` | publish | seconds | `60` | `60` | How long a build spends drawing. The rest wait for the next pass. |
| `RENDER_CACHE_DIR` | render | path | a folder under `/tmp` | `/tmp/render-cache` | Where the renderer keeps Wowhead's files. |
| `RENDER_CACHE_MB` | render | MiB | `256` | `256` | The most disk the renderer's cache may take. |
| `RENDER_TIMEOUT_S` | publish, render | seconds | `120` in `publish`, `90` in `render` | `120` | The longest one picture may take. |
| `RENDER_URL` | publish | URL | empty: no pictures | `http://render:8083` | The renderer that draws each past level's picture. |

## Several people on one install

Off until `WOW_STATE_DIR` is set. [Add friends](https://sam-dumont.github.io/wow-mcp/self-host/friends/).

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `DOH_URL` | ui | URL | empty | `https://cloudflare-dns.com/dns-query` | A DNS-over-HTTPS resolver, to tell whether a friend's host resolves yet. |
| `FRIENDS_RECONCILE_S` | ui | seconds | `120` | `120` | How often the friends list gets a full pass anyway (a change to the file applies sooner, within about 10 seconds); it retries what failed. |
| `FRIENDS_VL_DELETE_KEY_FILE` | ui, users | path | empty | `/run/secrets/vl_delete_key` | That VictoriaLogs' `-deleteAuthKey`, so a friend's events can be deleted. |
| `FRIENDS_VL_URL` | ui, publish, users | URL | empty: no friends | `http://vl-friends:9428` | The friends' VictoriaLogs, one tenant each. |
| `PRIVACY_BACKUP_DAYS` | ui | days | empty: the privacy page says to ask the owner | `30` | How long your backups keep events, as the privacy page tells your friends. |
| `PRIVACY_LOG_DAYS` | ui | days | empty: the privacy page says to ask the owner | `30` | How long the server's logs keep a request (the web server's access log and the app's own log), as the privacy page tells your friends. |
| `PROFILE_CHARACTERS_URL` | exporter | URL | empty | `http://ui:8091/profile-characters` | Adds every person's characters to `PROFILE_CHARACTERS`, each under its own account: at most 12 a day per friend. |
| `PROXY_USER_HEADER` | ui | header name | `X-Forwarded-User` | `X-Forwarded-User` | The header your login proxy puts the account id in. The proxy must strip any copy the client sent. |
| `PUBLIC_URL` | ui | URL | empty | `https://wow-full.example.org` | The full view's address, for install commands and the MCP. |
| `PUBLISH_REPORT_URL` | publish | URL | `USERS_URL`'s folder, `/publisher.json` | `http://ui:8091/publisher.json` | Where the publisher reports each pass, for the owner's overview (`/admin`). |
| `SITE_ALIASES` | static | comma list of `host=slug` | empty | `wow.example.org=alex` | Extra hosts and whose site each one serves. |
| `SITE_DOMAIN` | ui, static | domain | empty | `example.org` | Friends' sites live at `<slug>-wow.<domain>`. |
| `USERS_URL` | publish | URL | empty: one site | `http://ui:8091/users.json` | The full view's share port: build one site per person. |
| `WOW_FRIENDS_FILE` | ui, users | path to JSON `{"<sub>": "<slug>"}` | empty: the owner only | `/run/wow/friends.json` | Who gets in besides the owner. Watched while the server runs: a change applies within about 10 seconds, without a restart (mount its folder, not the file alone). A person who leaves the list is offboarded at once. |
| `WOW_OWNER_ALIASES` | ui, users | comma list of hosts | empty | `wow.example.org` | Hosts that belong to the owner too. |
| `WOW_OWNER_SLUG` | ui, users | 2 to 20 of a-z, 0-9 | `sam`: set your own | `alex` | The owner's site name. Refusal pages name the owner by it. |
| `WOW_OWNER_SUB` | ui, users | text | empty | `3f2c9a10-...` | The owner's account id at the identity provider. |
| `WOW_STATE_DIR` | ui, users | path | empty: one person | `/data/people` | Turns on several people per install: the registry and each person's state live here. |
| `ZOGZOG_MASTER_KEY_FILE` | ui, publish, users | path, 32+ random bytes, base64url | empty | `/run/secrets/zogzog_master` | Each person's sealed-site key is derived from it, so the full view and the publisher agree without sharing a file. |

## The Battle.net exporter (`wow-stats exporter`)

Optional. Needs your own API client. [Battle.net data](https://sam-dumont.github.io/wow-mcp/self-host/battlenet/).

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `BNET_CLIENT_ID_FILE` | exporter | path | required | `/run/secrets/bnet_client_id` | A file holding **your own** Battle.net API client id. |
| `BNET_CLIENT_SECRET_FILE` | exporter | path | required | `/run/secrets/bnet_client_secret` | A file holding that client's secret. |
| `BNET_FOREVER_NAMESPACE` | exporter | text | `dynamic-forever-<region>` | `dynamic-forever-eu` | The API namespace for Forever's ruleset status. |
| `BNET_LOCALE` | exporter | locale | `en_GB` | `en_US` | The language of names in the API's answers. |
| `BNET_PROFILE_NAMESPACE` | exporter | text | `profile-forever-<region>` | `profile-forever-eu` | The namespace for character profiles. |
| `BNET_REGION` | exporter, compose | `eu`, `us`, `kr` or `tw` | `eu` | `us` | Your Battle.net region. |
| `BNET_TOKEN_NAMESPACES` | exporter | comma list | derived from the region | `dynamic-eu` | The namespaces read for the WoW Token price. |
| `HTTP_TIMEOUT` | exporter | seconds | `60` | `60` | Timeout of one API call. |
| `LISTEN_PORT` | exporter | port | `9464` | `9464` | The exporter's own port: `/healthz` and its own health metrics on `/metrics`, never Blizzard's data. |
| `PROFILE_CHARACTERS` | exporter, compose | comma list of `Name-Surname` | empty | `Testchar-Demo,Testalt-Demo` | Your characters, as their WTF folders name them: their look, level, gear and talents are read once a day. |
| `PROFILE_INTERVAL` | exporter | seconds | `86400` | `86400` | Seconds between profile reads. |
| `REALM_INTERVAL` | exporter | seconds | `300` | `300` | Seconds between ruleset status reads. |
| `TOKEN_INTERVAL` | exporter | seconds | `1200` | `1200` | Seconds between WoW Token reads. |
| `VM_MERGE_INTERVAL` | exporter | seconds | `86400` | `86400` | Seconds between force-merges. |
| `VM_MERGE_KEY_FILE` | exporter | path | empty | `/run/secrets/vm_merge_key` | VictoriaMetrics' `-forceMergeAuthKey`. With it the exporter force-merges daily, so expired data is really deleted. |
| `VM_MERGE_URL` | exporter | URL | `VM_PUSH_URL`'s host + `/internal/force_merge` | `http://victoriametrics:8428/internal/force_merge` | Where the force-merge goes. |
| `VM_PUSH_EXTRA_LABELS` | exporter | comma list of `name=value` | empty | `site=home` | Labels added to every pushed series. |
| `VM_PUSH_INTERVAL` | exporter | seconds | `60` | `60` | Seconds between pushes. |
| `VM_PUSH_URL` | exporter | URL | empty: nothing stored | `http://victoriametrics:8428/api/v1/import/prometheus` | Where the exporter pushes. Must be a VictoriaMetrics with a retention under 30 days. |

## The player's computer

Read by the shipper and its installers, not by the server.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `WOW_STATS_CONFIG` | shipper | path | `~/.config/wow-stats/config.toml` (Mac), `%APPDATA%\wow-stats\config.toml` (Windows) | `~/wow-stats.toml` | Another config file for the shipper and its installers. |
| `WOW_STATS_NO_LOAD` | shipper, installer | `1` | empty | `1` | Install without starting the background job. For tests and trying the installer. |
| `WOW_STATS_QUIET` | installer | `1` | empty | `1` | The installers print less. Set by the install command itself. |
| `WOW_STATS_WOW_DIR` | installer | path | found by itself in the usual places | `D:\Games\World of Warcraft\_forever_` | The `_forever_` folder, when WoW is somewhere unusual. For the install command from the start page. |

## The compose kit's `.env` only

Read by `docker compose` in `deploy/compose`, not by a program. The other compose settings are the variables above, passed through.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `ACME_EMAIL` | compose | email address | required by `compose.traefik.yaml` | `you@example.org` | Where Let's Encrypt writes before a certificate expires (Traefik). |
| `MCP_PUBLISH` | compose | `address:port` | `127.0.0.1:8090` | `127.0.0.1:8090` | Where the MCP port is published on the host. |
| `PUBLIC_ALLOWED_HOSTS` | compose | host names, comma separated | empty | `wow.example.org` | `ALLOWED_HOSTS` for the `ui-public` service. |
| `PUBLIC_ALLOW_OPEN` | compose | `1` or empty | empty | `1` | `ALLOW_OPEN` for the `ui-public` service, when you publish it beyond `127.0.0.1`. |
| `PUBLIC_PUBLISH` | compose | `address:port` | `127.0.0.1:8082` | `127.0.0.1:8082` | The optional live public view (profile `public`). |
| `SITE_PUBLISH` | compose | `address:port` | `127.0.0.1:8081` | `127.0.0.1:8081` | Where the static sites are published on the host. |
| `SITE_URL` | compose | URL | `http://127.0.0.1:8081` | `https://wow.example.org` | The static sites' address, for the printed `/zogzog/` link (`ZOGZOG_LINK_BASE`). |
| `UI_ALLOWED_HOSTS` | compose | host names, comma separated | empty | `nas.local` | `ALLOWED_HOSTS` for the `ui` service. |
| `UI_AUTH` | compose | as `AUTH` | `open` | `basic` | The full view's `AUTH`. `open` is fine while the port stays on 127.0.0.1. |
| `UI_MEM_LIMIT` | compose | size | `1g` | `2g` | The memory limit of `ui`. |
| `UI_PUBLISH` | compose | `address:port` | `127.0.0.1:8080` | `0.0.0.0:8080` | Where the full view is published on the host. Leave it on 127.0.0.1 unless a login is set. |
| `VL_MAX_DISK` | compose | size | `0`: no ceiling | `20GiB` | A disk ceiling for the game events. Past it VictoriaLogs deletes the oldest days, for good. |
| `WOW_FULL_HOST` | compose | host name | required by the proxy files | `wow-full.example.org` | Your full view's and the MCP's host, for the proxy files. They also put it in `ALLOWED_HOSTS`. |
| `WOW_SITE_HOST` | compose | host name | required by the proxy files | `wow.example.org` | The static sites' host, for `compose.caddy.yaml`, `compose.traefik.yaml` or `compose.nginx.yaml`. Point its DNS at the server. |
| `WOW_STATS_IMAGE` | compose | image reference | `wow-stats:local`, built from the tree | `ghcr.io/<owner>/wow-mcp:0.5.0@sha256:...` | Run a released image instead of building the tree. |

## Tests and development

Point an upstream at a local server. Leave them alone in production.

| Variable | Read by | Type | Default | Example | What it does |
|---|---|---|---|---|---|
| `BNET_API_URL` | exporter | URL | `https://<region>.api.blizzard.com` | `http://127.0.0.1:9002` | Blizzard's API. Tests point it at a local server. |
| `BNET_OAUTH_URL` | exporter | URL | `https://oauth.battle.net/token` | `http://127.0.0.1:9002/token` | Blizzard's token endpoint. Tests point it at a local server. |
| `ICON_URL` | ui, publish | URL | `https://wow.zamimg.com/images/wow/icons/` | `http://127.0.0.1:9000/icons/` | Where item icons are fetched. Tests point it at a local server. |
| `MODEL3D_PRODUCT` | ui, publish | text | `wowf` | `wowf` | The game build family read on wago.tools. |
| `MODEL3D_REFERENCE` | ui, publish | path | the bundled `model3d-reference.json.gz` | `./tests/armor.json` | Another armor reference ([Model reference](https://sam-dumont.github.io/wow-mcp/game-data/model3d-reference/)). Tests point it at a made-up one. |
| `MODEL3D_WAGO_URL` | ui, publish | URL | `https://wago.tools` | `http://127.0.0.1:9001` | Forever's game tables. Tests point it at a local server. |
| `MODEL3D_ZAM_URL` | ui, publish, render | URL | `https://wow.zamimg.com/modelviewer/` | `http://127.0.0.1:9000/` | Wowhead's model host. Tests point it at a local server. |
| `STATIC_DIR` | ui | path | the packaged `web/` | `./web` | Serve the page's files from another folder. For working on the page. |
| `WOW_STATS_RECORDER_SHA256` | shipper | hex | the pinned release's | `e3b0c442...` | The checksum that zip must have. |
| `WOW_STATS_RECORDER_URL` | shipper | URL | the pinned Polestar Recorder release | `file:///tmp/Polestar_Recorder.zip` | Where the installer gets Polestar Recorder. Tests only; pair it with `WOW_STATS_RECORDER_SHA256`. |
