npm install -g yarn
git clone https://github.com/umami-software/umami.git
.env file with the following
The connection url is in the following format:
The first time the build is run, it will create all the required database tables in your database. It will also create a login account with username admin and password umami.
You can simply run
yarn start to start Umami, but it's highly recommended you use a process manager like PM2 which will handle restarts for you.
To run with PM2:
yarn global add pm2
pm2 start yarn --name umami -- start
Umami ships with a docker compose that contains the application and a PostgreSQL database.
To build the Docker container and start up with a Postgres database, run:
docker-compose up -d
Alternatively, if you want to use prebuilt images, you can pull the Umami Docker image with PostgreSQL support:
docker pull ghcr.io/umami-software/umami:postgresql-latest
Or with MySQL support:
docker pull ghcr.io/umami-software/umami:mysql-latest