-
Notifications
You must be signed in to change notification settings - Fork 10
Configuration
adamkobor edited this page Oct 1, 2020
·
11 revisions
Kuvasz is configurable through environment variables, you can find all the available variables below:
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| DATABASE_HOST | no | string (hostname) | localhost | The database's host |
| DATABASE_PORT | no | number | 5432 | The database's port |
| DATABASE_NAME | no | string | postgres | The database's name |
| DATABASE_USER | yes | string | The database user's username | |
| DATABASE_PASSWORD | yes | string | The database user's password |
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| JWT_SIGNATURE_SECRET | yes | string | The JWT token generator's secret, must be at least 256 bits long | |
| ADMIN_USER | yes | string | The admin user's username | |
| ADMIN_PASSWORD | yes | string | The admin user's password |
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| ENABLE_HTTP_COMMUNICATION_LOG | no | true | false | false | Toggles the HTTP communication log. It could be useful for debugging a connection problem. |
| DATA_RETENTION_DAYS | no | number (minimum value = 7) | 30 | Kuvasz will retain your logs (about uptime and SSL events and measured latencies) for X days |
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| ENABLE_LOG_EVENT_HANDLER | no | true | false | true | Toggles the log based event handler. This handler writes the events coming from monitors (i.e. UP/DOWN/redirected) to STDOUT. |
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| ENABLE_SMTP_EVENT_HANDLER | no | true | false | false | Toggles the SMTP based event handler. If you enable it, you should also provide proper values for the variables below. |
| SMTP_FROM_ADDRESS | depends on ENABLE_SMTP_EVENT_HANDLER | string (email) | The sender's address for SMTP event handler. | |
| SMTP_TO_ADDRESS | depends on ENABLE_SMTP_EVENT_HANDLER | string (email) | The recipient's address for SMTP event handler. This is where Kuvasz sends the email notifications about monitors. | |
| SMTP_HOST | depends on ENABLE_SMTP_EVENT_HANDLER | string (host) | The SMTP server's host | |
| SMTP_PORT | depends on ENABLE_SMTP_EVENT_HANDLER | number | The SMTP server's port | |
| SMTP_USERNAME | no | string | "" | |
| SMTP_PASSWORD | no | string | "" | |
| SMTP_TRANSPORT_STRATEGY | no | SMTP | SMTP_TLS | SMTPS | SMTP_TLS | The transport strategy for the SMTP connection. |
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| ENABLE_SLACK_EVENT_HANDLER | no | true | false | false | Toggles the Slack event handler. If you enable it, you should also provide a proper value for SLACK_WEBHOOK_URL |
| SLACK_WEBHOOK_URL | depends on ENABLE_SLACK_EVENT_HANDLER | string (url) | The URL of your incoming webhook for Slack. |
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| ENABLE_TELEGRAM_EVENT_HANDLER | no | true | false | false | Toggles the Telegram event handler. If you enable it, you should also provide proper values for TELEGRAM_API_TOKEN and TELEGRAM_CHAT_ID |
| TELEGRAM_API_TOKEN | depends on ENABLE_TELEGRAM_EVENT_HANDLER | string | The dedicated API token of your Bot | |
| TELEGRAM_CHAT_ID | depends on ENABLE_TELEGRAM_EVENT_HANDLER | string | The ID or @channelusername where the notifications will be sent |
| Variable name | Required? | Type/Values | Default value | Description |
|---|---|---|---|---|
| ENABLE_PAGERDUTY_EVENT_HANDLER | no | true | false | false | Toggles the PagerDuty event handler. If you enable it, you should also provide your PagerDuty service's integration key for the given monitor to make the integration work |