Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2020-10-07 08:31:44 -07:00
.github Convert buttons to links. 2020-09-15 19:16:05 -07:00
assets Added error message component. Update fetch hook. 2020-10-03 22:36:51 -07:00
components Added error message component. Update fetch hook. 2020-10-03 22:36:51 -07:00
hooks Added error message component. Update fetch hook. 2020-10-03 22:36:51 -07:00
lang Add missing dutch translations 2020-10-07 11:54:45 +00:00
lib Removed disconnect code. 2020-10-07 08:31:44 -07:00
pages Add force SSL check. 2020-10-03 21:54:21 -07:00
prisma Enable public website sharing. 2020-08-15 01:17:15 -07:00
public Add country name download script. 2020-10-03 11:21:44 -07:00
redux Update version check. Updated packages. 2020-10-02 10:25:31 -07:00
scripts Add country name download script. 2020-10-03 11:21:44 -07:00
sql MySQL query optimization. Added loading component. 2020-08-27 23:45:37 -07:00
styles Responsive CSS updates. 2020-09-21 21:34:55 -07:00
tracker Add domain filter to tracker. 2020-10-04 22:27:59 -07:00
.dockerignore for better local building performance 2020-08-23 14:07:01 +12:00
.eslintrc.json Updated pages and referrer filters to merge urls. 2020-08-22 19:05:07 -07:00
.gitignore Added vscode to gitignore 2020-09-29 23:45:38 +00: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 Updated packages. Fixed docker file. 2020-09-26 22:20:53 -07: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 Merge pull request #271 from fransallen/master 2020-10-07 08:29:31 -07:00
package.json Removed disconnect code. 2020-10-07 08:31:44 -07:00
postcss.config.js Initial commit. 2020-07-17 01:03:38 -07: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 Added Norwegian language. 2020-10-02 11:41:29 -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/

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