Besides the required
HASH_SALT variables in your
you can configure Umami with some additional variables.
IGNORE_IP = <ip addresses>
You can provide a comma-delimited list of IP address to exclude from data collection.
FORCE_SSL = 1
This will redirect all requests from
https in the Umami application. Note, this does not apply to the tracking script.
LOG_QUERY = 1
If you are running in development mode, this will log database queries to the console for debugging.
HOSTNAME = <hostname>
PORT = <port number>
If you are running on an environment which requires you to bind to a specific hostname or port, such as Heroku, you can add
these variables and start your app with
npm run start-env instead of
CLIENT_IP_HEADER = <header name>
HTTP header to check for the client's IP address. This is useful when you're behind a proxy that uses non-standard headers.
DISABLE_LOGIN = 1
Disables the login page for the application.
REMOVE_TRAILING_SLASH = 1
Removes the trailing slash from all incoming urls.
TRACKER_SCRIPT_NAME = <script name>
Allow you to assign a custom name to the tracker script. The default is
umami. If you update this, be sure to update the tracking code on your website to the new name.
DISABLE_TELEMETRY = 1
Disable collection of completely anonymous telemetry data during installation.
When building a custom image
Required docker build arguments.
BASE_PATH = <path>
(optional) If you want to host Umami under a subdirectory. Only used to prefix URLs at frontend. May need to use reverse proxy to remove BASE_PATH prefix and pass modified URL to umami
DATABASE_TYPE = postgresql | mysql
(required) The type of the DB to be used.