Configuration Reference
简体中文 | English
Compose Environment Variables
The release default.env.example contains these variables:
| Variable | Default | Purpose |
|---|---|---|
IPCHRONICLE_HTTP_PORT | 8080 | Host port published by the standard Compose |
IPCHRONICLE_ADMIN_USERNAME | admin | Username used when creating the first administrator |
IPCHRONICLE_ADMIN_PASSWORD | admin | Password used when creating the first administrator |
CLOUDFLARE_TUNNEL_TOKEN | empty | Tunnel token used by the Cloudflare Compose file |
Bootstrap credentials do not modify an existing administrator account. CLOUDFLARE_TUNNEL_TOKEN is required only with compose.cloudflare-tunnel.yaml.
Center Image Environment Variables
The ghcr.io/ipchronicle/ipchronicle-center image supports all of the following variables when run directly or from a custom Compose file:
| Variable | Default | Purpose |
|---|---|---|
IPCHRONICLE_LISTEN_ADDRESS | :8080 | Center HTTP listen address |
IPCHRONICLE_DATA_DIR | /var/lib/ipchronicle | Default persistent-data root |
IPCHRONICLE_CONFIG_DATABASE_PATH | /var/lib/ipchronicle/config/config.db | Configuration database path |
IPCHRONICLE_HISTORY_DATABASE_PATH | /var/lib/ipchronicle/history/history.db | History database path |
IPCHRONICLE_LOGS_DATABASE_PATH | /var/lib/ipchronicle/logs/logs.db | Agent operational-log database path |
IPCHRONICLE_MASTER_KEY_PATH | /var/lib/ipchronicle/config/master.key | Credential-encryption master-key path |
IPCHRONICLE_ADMIN_USERNAME | admin | Username for the first administrator |
IPCHRONICLE_ADMIN_PASSWORD | admin | Password for the first administrator |
IPCHRONICLE_HEALTHCHECK_URL | http://127.0.0.1:8080/healthz | URL used by healthcheck |
Persistent-file paths must be absolute. An explicitly configured database or master-key path overrides its corresponding default derived from IPCHRONICLE_DATA_DIR.
System Settings
External Origin
Automatic mode uses the current administrator browser origin. Custom mode accepts an HTTP or HTTPS origin and uses it in Agent installation commands and notification detail links. HTTP remains usable and displays a security warning.
ipapi API Key
Complete probes can use the ipapi provider. Without an API key, corresponding fields may be unavailable; other providers are unaffected. Create an account on the ipapi sign-up page, then save or clear the key under Settings > System.
The key is encrypted in the Center config.db and sent only to Agents that need to run a probe. The API and web interface do not return its saved plaintext value.
Public-IP Discovery Services
Under Settings > Network probes, configure two to eight different service hosts for each of IPv4 and IPv6. HTTP and HTTPS URLs are accepted; HTTP displays a warning. An address is confirmed only when multiple services agree.