<h1>Environment variables</h1>
<p>You can configure Umami with the use of environment variables. They go into the same <code>.env</code> file as your <code>DATABASE_URL</code>.</p>
<hr>
<h2>Runtime variables</h2>
<p>Runtime variables are recognized when Umami is running. You can set your environment variables prior to starting the application.</p>
<h3>DATABASE_URL = &#x3C;connection string></h3>
<p>Connection string for your database. This is the only required variable.</p>
<h3>IGNORE_IP = &#x3C;ip addresses></h3>
<p>You can provide a comma-delimited list of IP address to exclude from data collection.</p>
<h3>FORCE_SSL = 1</h3>
<p>This will redirect all requests from <code>http</code> to <code>https</code> in the Umami application. Note, this does not apply to the tracking script.</p>
<h3>LOG_QUERY = 1</h3>
<p>If you are running in development mode, this will log database queries to the console for debugging.</p>
<h3>HOSTNAME = &#x3C;hostname></h3>
<h3>PORT = &#x3C;port number></h3>
<p>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 <code>npm run start-env</code> instead of <code>npm start</code>.</p>
<h3>CLIENT_IP_HEADER = &#x3C;header name></h3>
<p>HTTP header to check for the client's IP address. This is useful when you're
behind a proxy that uses non-standard headers.</p>
<h3>REMOVE_TRAILING_SLASH = 1</h3>
<p>Removes the trailing slash from all incoming urls.</p>
<h3>TRACKER_SCRIPT_NAME = &#x3C;script name></h3>
<p>Allows you to assign a custom name to the tracker script different from the default <code>umami</code>. This is to help you avoid some ad-blockers.</p>
<p>Note: If you update this, be sure to update the tracking code on your website to the new name.</p>
<h3>COLLECT_API_ENDPOINT = /api/x</h3>
<p>Allows you to send metrics to a location different than the default <code>/api/collect</code>. This is to help you avoid some ad-blockers.</p>
<h3>DISABLE_UPDATES = 1</h3>
<p>Disables the check for new versions of Umami.</p>
<h3>DISABLE_LOGIN = 1</h3>
<p>Disables the login page for the application.</p>
<h3>DISABLE_TELEMETRY = 1</h3>
<p>Umami collects completely anonymous telemetry data in order help improve the application. You can choose to disable this if you don't want to participate.</p>
<h3>HASH_SALT = &#x3C;random string></h3>
<p>A random string used to generate unique values.</p>
<hr>
<h2>Build time variables</h2>
<p>Build time variables are only recognized during the build process. This also includes building custom Docker images. You need to set your environment variables prior to building the application.</p>
<h3>BASE_PATH = &#x3C;path></h3>
<p>If you want to host Umami under a subdirectory. You may need to update your reverse proxy settings to correctly handle the BASE_PATH prefix.</p>
<h3>DATABASE_TYPE = &#x3C;postgresql | mysql></h3>
<p>The type of DB to be used. This is only required for the Docker build.</p>


Documentation

Basics

Advanced

Guides