Skip to content

Environment Variables ​

All configuration is done through environment variables (.env, docker run -e, or docker-compose.yml).


Monitoring Sources ​

VariableDefaultDescription
UPTIME_KUMA_URL""Base URL of your Uptime Kuma server (auto-enables Uptime Kuma).
UPTIME_KUMA_API_KEY""Uptime Kuma API key (uk1_...).
UPTIME_KUMA_POLL_INTERVAL60000Uptime Kuma polling interval in ms.
UPTIMEROBOT_API_KEY""UptimeRobot API key (auto-enables UptimeRobot).
UPTIMEROBOT_POLL_INTERVAL30000UptimeRobot polling interval in ms.
KATO_ADAPTERmockExplicit provider (mock, uptimekuma, uptimerobot, or comma-separated).
KATO_ADAPTERS""Multi-instance aliases (e.g., kuma_prod,kuma_lan,robot_main).
KATO_MOCK_COUNT50Number of simulated monitors in mock demo mode.

Multi-Instance Variables (KATO_ADAPTERS) ​

For each <ALIAS> in KATO_ADAPTERS (in uppercase):

VariableDefaultDescription
ADAPTER_<ALIAS>_TYPEAutouptimekuma, uptimerobot, or mock (auto-detected if alias contains kuma or robot).
ADAPTER_<ALIAS>_URL""Base URL for uptimekuma.
ADAPTER_<ALIAS>_API_KEY""API key for uptimekuma or uptimerobot.
ADAPTER_<ALIAS>_POLL_INTERVAL30000 / 60000Polling interval in ms.

Security & Network ​

VariableDefaultDescription
KATO_AUTH_ENABLEDfalseRequire a password to access the dashboard.
KATO_AUTH_PASSWORDchangemePassword when KATO_AUTH_ENABLED=true.
PORT / HOST3000 / 0.0.0.0Listening port and network address.

Default Display Preferences ​

VariableDefaultOptionsDescription
KATO_DEFAULT_LOCALEenen, frDefault UI language.
KATO_DEFAULT_THEMEdarkdark, light, amoled, autoDefault visual theme.
KATO_DEFAULT_TIME_FORMAT24h24h, 12hClock format.
KATO_DEFAULT_TIME_ZONElocallocal, UTC, IANA TZClock timezone (e.g., Europe/Paris).
KATO_DEFAULT_SHOW_SECONDStruetrue, falseShow seconds in the header clock.
KATO_DEFAULT_SOUND_ENABLEDfalsetrue, falseEnable audio alerts by default.
KATO_DEFAULT_NOTIFICATIONS_ENABLEDfalsetrue, falseEnable desktop notifications by default.
KATO_DEFAULT_MARQUEE_SPEEDslowslow, normal, fastBottom incident ticker speed.

Released under the MIT License.