Umami is a simple, fast, website analytics alternative to Google Analytics.
A detailed getting started guide can be found at https://umami.is/docs/
- A server with Node.js 10.13 or newer
- A database (MySQL or Postgresql)
git clone https://github.com/mikecao/umami.git
cd umami
npm install
Umami supports MySQL and Postgresql. Create a database for your Umami installation and install the tables with the included scripts.
For MySQL:
mysql -u username -p databasename < sql/schema.mysql.sql
For Postgresql:
psql -h hostname -U username -d databasename -f sql/schema.postgresql.sql
This will also create a login account with username admin and password umami.
Create an .env file with the following
DATABASE_URL=(connection url)
HASH_SALT=(any random string)
The connection url is in the following format:
postgresql:https://username:mypassword@localhost:5432/mydb
mysql:https://username:mypassword@localhost:3306/mydb
The HASH_SALT is used to generate unique values for your installation.
npm run build
npm start
By default this will launch the application on https://localhost:3000. You will need to either
proxy requests from your web server
or change the port to serve the application directly.
To build the umami container and start up a Postgres database, run:
docker-compose up
MIT