Configuration

Kuvasz is configurable through environment variables, you can find all the available variables below:

Database connection

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

Authentication

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

App config

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 events and measured latencies) for X days

Event handlers

Log

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 (e.g. UP/DOWN/redirected) to STDOUT.

SMTP

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.

Slack

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.