Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
Adam Coard 992908c728 Added vscode to gitignore 2020-09-29 23:45:38 +00:00
.github Convert buttons to links. 2020-09-15 19:16:05 -07:00
assets New icons for theme button. 2020-09-20 15:42:01 -07:00
components Try another path. 2020-09-26 22:02:10 -07:00
hooks URL filter functionality. 2020-09-25 22:31:18 -07:00
lang Merge branch 'master' into dev 2020-09-25 00:16:20 -07:00
lib Try another path. 2020-09-26 22:02:10 -07:00
pages Convert buttons to links. 2020-09-25 23:38:28 -07:00
prisma
public
redux Dark mode. 2020-09-20 01:33:39 -07:00
scripts Move geo database to public folder. 2020-09-26 21:18:15 -07:00
sql
styles Responsive CSS updates. 2020-09-21 21:34:55 -07:00
tracker Renamed methods in tracker. 2020-09-18 15:26:45 -07:00
.dockerignore
.eslintrc.json
.gitignore Added vscode to gitignore 2020-09-29 23:45:38 +00:00
.prettierignore
.prettierrc.json
.stylelintrc.json
Dockerfile Updated packages. Fixed docker file. 2020-09-26 22:20:53 -07:00
LICENSE
README.md
docker-compose.yml Update docker-compose.yml 2020-09-25 07:25:06 +02:00
jsconfig.json
next.config.js Updated next config. 2020-09-26 20:46:20 -07:00
package.json Updated packages. Fixed docker file. 2020-09-26 22:20:53 -07:00
postcss.config.js
rollup.tracker.config.js Refactor tracker. 2020-09-18 13:40:46 -07:00
yarn.lock Updated packages. Fixed docker file. 2020-09-26 22:20:53 -07:00

README.md

umami

Umami is a simple, fast, website analytics alternative to Google Analytics.

Getting started

A detailed getting started guide can be found at https://umami.is/docs/

Installing from source

Requirements

  • A server with Node.js 10.13 or newer
  • A database (MySQL or Postgresql)

Get the source code and install packages

git clone https://github.com/mikecao/umami.git
cd umami
npm install

Create database tables

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.

Configure 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://username:mypassword@localhost:5432/mydb

mysql://username:mypassword@localhost:3306/mydb

The HASH_SALT is used to generate unique values for your installation.

Build the application

npm run build

Start the application

npm start

By default this will launch the application on http://localhost:3000. You will need to either proxy requests from your web server or change the port to serve the application directly.

Installing with Docker

To build the umami container and start up a Postgres database, run:

docker-compose up

Alternatively, to pull just the Umami Docker image with PostgreSQL support:

docker pull ghcr.io/mikecao/umami:postgresql-latest

Or with MySQL support:

docker pull ghcr.io/mikecao/umami:mysql-latest

Getting updates

To get the latest features, simply do a pull, install any new dependencies, and rebuild:

git pull
npm install
npm run build

License

MIT