Configuration reference
CommunityTeamPro
All settings are environment variables; several clusters, users and OIDC are easier in an application.yml mounted to /app/config/ (see the README).
RabbitMQ
| Variable | Default | What it is |
|---|---|---|
WARREN_RABBIT_MANAGEMENT_URL | http://localhost:15672 | the management HTTP API |
WARREN_RABBIT_HOST / WARREN_RABBIT_PORT | localhost / 5672 | AMQP, used for replays |
WARREN_RABBIT_USERNAME / WARREN_RABBIT_PASSWORD | guest / guest | needs the management tag and read and write on the vhost; monitoring for disk and memory |
WARREN_RABBIT_VHOST | / | the vhost of this cluster entry |
WARREN_RABBIT_ID / WARREN_RABBIT_NAME | default / – | id in URLs, display name |
WARREN_DLQ_NAME_PATTERN | dlq, dlx, dead-letter, .dead, .failed, _error, _skipped | names that make a queue a dead-letter queue |
Server, database, users
| Variable | Default | What it is |
|---|---|---|
WARREN_PORT | 8080 | HTTP port |
WARREN_PUBLIC_URL | – | base URL for links in notifications |
WARREN_DATA_DIR | /app/data | embedded database |
WARREN_DB_URL / _USERNAME / _PASSWORD | embedded | a jdbc:postgresql:// URL for PostgreSQL (Pro) |
WARREN_ADMIN_USERNAME / WARREN_ADMIN_PASSWORD | admin / admin | the first local admin; change it |
WARREN_LICENSE_KEY / WARREN_LICENSE_FILE | – | a Team or Pro licence |
Metrics and alerting
| Variable | Default | What it is |
|---|---|---|
WARREN_METRICS_SAMPLE_INTERVAL | 30s | how often queues are sampled and alert rules evaluated |
WARREN_METRICS_RETENTION | 7d | raw samples |
WARREN_METRICS_LONG_RETENTION | 90d | Pro: hourly roll-ups |
WARREN_ALERTING_ENABLED / WARREN_ALERTING_RENOTIFY_AFTER | true / 4h | alert evaluation, reminders while an alert fires |
WARREN_SMTP_HOST / _PORT / _USERNAME / _PASSWORD / _FROM | – / 587 | mail server for e-mail channels |
WARREN_SMTP_STARTTLS / WARREN_SMTP_SSL | true / false | STARTTLS on 587, or TLS on 465 |
WARREN_PROMETHEUS_TOKEN | – | Team, Pro: bearer token for /actuator/prometheus |
Actions and messages
| Variable | Default | What it is |
|---|---|---|
WARREN_REQUIRE_DRY_RUN / WARREN_DRY_RUN_EXPIRES_AFTER | true / 10m | bulk actions only on a dry run's token, and how long it holds |
WARREN_MAX_PUBLISH_BYTES | 1 MiB | largest body a publish accepts |
WARREN_PEEK_CACHE_MAX_BYTES | 256 MiB | memory for peeked bodies |
WARREN_MASKING_ENABLED | true | hide sensitive values in the message view |
WARREN_MASKING_FIELDS | password,passwd,secret,token,apikey,… | names of fields and headers to hide |
WARREN_MASKING_VALUES | EMAIL,IBAN,CARD | value patterns hidden wherever they appear |
WARREN_MASKING_ALLOW_REVEAL | true | operators and admins may show one message's values |
Audit and approval
| Variable | Default | What it is |
|---|---|---|
WARREN_AUDIT_RETENTION | forever | age after which finished actions and resolved alert events are deleted |
WARREN_AUDIT_PAYLOAD_BYTES | 16 KiB | how much of each message body the audit log keeps |
WARREN_AUDIT_MIN_RETENTION | – | Pro: nothing younger is ever deleted |
WARREN_AUDIT_WEBHOOK_URL | – | Pro: every audit event as JSON |
WARREN_AUDIT_SYSLOG_HOST / _PORT / _PROTOCOL | – / 514 / UDP | Pro: every audit event as syslog |
WARREN_APPROVAL_ACTIONS | – | Pro: REPLAY, DISCARD, PURGE that wait for a second operator |
WARREN_APPROVAL_EXPIRES_AFTER | 24h | Pro: when an undecided request expires |