Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2021-06-12 18:34:20 +08:00
.github Update docker login 2021-04-08 21:49:41 -07:00
assets Added button to show/hide charts, closes #577. 2021-04-28 02:02:59 -07:00
components Added button to show/hide charts, closes #577. 2021-04-28 02:02:59 -07:00
hooks Proper fix. 2021-04-28 02:18:54 -07:00
lang For lang zh-TW.json : Fix punctuation and optimize details. 2021-06-12 18:34:20 +08:00
lib enhancement #649 2021-05-06 10:47:23 +02:00
pages Support CIDR notation in IGNORE_IP, closes #544. 2021-04-25 23:57:49 -07:00
prisma Prisma Migrate with database seeding fixes #559 2021-03-20 23:01:10 +11:00
public Fix datamaps. 2021-03-26 22:32:13 -07:00
redux Created share token hook. 2020-10-11 02:29:55 -07:00
scripts Update referrer. 2021-03-26 20:01:25 -07:00
sql Fix charset issues on mySQL (fixes #388) 2020-11-28 00:42:00 +01:00
styles Added font for Chinese traditional. 2021-03-12 22:53:56 -08:00
tracker Update tracker script. 2021-02-01 22:49:00 -08:00
.dockerignore for better local building performance 2020-08-23 14:07:01 +12:00
.eslintrc.json Updated packages. 2021-04-24 21:27:24 -07:00
.gitignore Updated log display. 2020-10-14 14:16:00 -07:00
.prettierignore Add indexes to tables. 2020-07-17 19:33:40 -07:00
.prettierrc.json Initial commit. 2020-07-17 01:03:38 -07:00
.stylelintrc.json Initial commit. 2020-07-17 01:03:38 -07:00
docker-compose.yml Update docker-compose.yml 2020-09-25 07:25:06 +02:00
Dockerfile chore(docker): add base_path to build args 2021-05-08 19:48:51 +08:00
jsconfig.json Initial commit. 2020-07-17 01:03:38 -07:00
lang-ignore.json Added Czech language. 2020-10-22 10:36:08 -07:00
LICENSE Added license. 2020-08-17 00:05:57 -07:00
next.config.js Add environment variable for basePath. 2020-12-03 22:28:05 -08:00
package.json Swap bcrypt library. 2021-04-28 02:45:38 -07:00
postcss.config.js Initial commit. 2020-07-17 01:03:38 -07:00
Procfile Add Procfile to tell Heroku how to start the app 2020-10-25 22:58:56 +00:00
README.md Added page not found string. 2020-09-12 09:59:19 -07:00
rollup.tracker.config.js Updated api fetch to return an object. 2020-09-30 15:14:44 -07:00
yarn.lock build(deps): bump hosted-git-info from 2.8.8 to 2.8.9 2021-05-09 11:49:05 +00:00

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