Hosting

Running on Heroku

Deploy Umami on Heroku from a fork of the GitHub repository, with a Heroku Postgres add-on for the database and an APP_SECRET config var.

Heroku is a container-based cloud Platform as a Service (PaaS). Developers use Heroku to deploy, manage, and scale modern apps. The platform is elegant, flexible, and easy to use, offering developers the simplest path to getting their apps to market.

From the "What is Heroku?" section of their website.

Heroku provides a hosting service which works with Umami as well as databases through add-ons. You don't need to have a database set up before this setup guide.

Setup#

Deploy

Automate all steps using the button above.

Website#

  1. Fork a copy of the Umami repository.
  2. Create an account on Heroku.
  3. From the dashboard page click New > Create new app.
  4. Choose an App name and then click Create app.
  5. Under Deployment method click GitHub and follow the instructions to connect Heroku to GitHub.
  6. Search for the repository and click Connect.

Database#

  1. Navigate to the Resources tab and click on the Find more add-ons button.
  2. Search for Heroku Postgres and follow its instructions to install the add-on.
  3. The add-on will set the DATABASE_URL automatically; you should not have to manually set it.
  4. The required database tables are created automatically when the app is built, as described in the Build the application section of the Install docs.

Environment variables#

  1. Navigate to the Settings tab and click Reveal Config Vars.
  2. Add an APP_SECRET config var with a random string as its value, for example the output of openssl rand -hex 32.

Build and Deploy#

  1. With the environment variables and database set up, click the Deploy > Manual Deploy > Deploy Branch button.
  2. Once the build has finished, the website should be live. Follow the Open app button at the top of the dashboard to view it.
  3. Follow the Quickstart guide starting from the Login step.