Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
Mike Cao 5ad0ff3fa4
Merge pull request #14 from dbirks/feature/add-docker
Add Dockerfile and docker-compose.yml
2020-08-20 22:58:36 -07:00
assets Enable public website sharing. 2020-08-15 01:17:15 -07:00
components Fixed bug with rankings display. 2020-08-19 23:30:31 -07:00
hooks Added user button and menu. 2020-08-05 23:03:07 -07:00
lib Implement rotating salt. 2020-08-20 19:38:20 -07:00
pages Removed session code. 2020-08-20 19:17:27 -07:00
prisma Enable public website sharing. 2020-08-15 01:17:15 -07:00
public Removed session code. 2020-08-20 19:17:27 -07:00
redux Implement redux. 2020-08-04 22:45:05 -07:00
sql Update password hashes. 2020-08-19 03:16:02 -07:00
styles Show active visitor count. 2020-08-18 00:51:32 -07:00
tracker Removed session code. 2020-08-20 19:17:27 -07:00
.eslintrc.json Added world map component. 2020-08-01 03:34:56 -07:00
.gitignore Capture pushState events. 2020-07-18 22:51:17 -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 Add Dockerfile and docker-compose.yml 2020-08-19 00:25:05 -04:00
Dockerfile Add Dockerfile and docker-compose.yml 2020-08-19 00:25:05 -04:00
jsconfig.json Initial commit. 2020-07-17 01:03:38 -07:00
LICENSE Added license. 2020-08-17 00:05:57 -07:00
next.config.js Initial commit. 2020-07-17 01:03:38 -07:00
package.json Implement rotating salt. 2020-08-20 19:38:20 -07:00
postcss.config.js Initial commit. 2020-07-17 01:03:38 -07:00
README.md Merge branch 'master' into feature/add-docker 2020-08-20 22:58:04 -07:00
rollup.tracker.config.js Build cli using rollup. 2020-07-24 17:00:56 -07:00
yarn.lock Enable public website sharing. 2020-08-15 01:17:15 -07: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/

Installation from source

Requirements

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

Get the source code

git clone https://github.com/mikecao/umami.git

Go into the repo folder

cd umami

Install packages

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.

Generate database client

Depending on your database type, run the appropriate script.

For MySQL:

npm run build-mysql-client

For Postgresql:

npm run build-postgresql-client

Create a production build

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.

Installation with Docker

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

docker-compose up

License

MIT