Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2022-10-06 14:18:27 -07:00
.github Skip database check during CI. 2022-08-25 00:49:47 -07:00
.husky Fix build issues. 2021-11-22 14:53:36 -08:00
assets Updated packages. 2022-03-31 09:55:42 -07:00
components Merge branch 'dev' of https://github.com/umami-software/umami into dev 2022-10-03 17:17:53 -07:00
db add mysql changes 2022-10-02 20:42:32 -07:00
hooks Fix issue with generating URLs. 2022-09-05 12:04:30 -07:00
lang Merge branch 'master' into dev 2022-09-06 12:04:37 -07:00
lib Added getWebsite method. 2022-10-06 14:18:27 -07:00
pages Added getWebsite method. 2022-10-06 14:18:27 -07:00
public Updated language bundles. 2022-09-12 14:36:27 -07:00
queries Added getWebsite method. 2022-10-06 14:18:27 -07:00
scripts update check-db 2022-10-03 11:14:19 -07:00
sql Unify database changes. Closes #1264 2022-07-06 20:45:53 -07:00
store Use next-basics package. 2022-08-28 20:20:54 -07:00
styles Features: 2022-08-26 17:22:46 +02:00
tracker Update tracker to use no dependencies. 2022-08-28 15:55:18 -07:00
.dockerignore for better local building performance 2020-08-23 14:07:01 +12:00
.eslintrc.json Use next-basics package. 2022-08-28 20:20:54 -07:00
.gitignore fix clickhouse calls (#1536) 2022-09-23 22:43:51 -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 Update readme. 2022-04-07 18:15:45 -07:00
app.json Update the links for current repository 2022-07-21 14:31:09 +02:00
docker-compose.yml Update the links for current repository 2022-07-21 14:31:09 +02:00
Dockerfile Run migration on build 2022-08-23 10:49:45 -07:00
jsconfig.json Initial commit. 2020-07-17 01:03:38 -07:00
lang-ignore.json Merge pull request #1381 from winterrific/master 2022-08-03 16:04:20 -05:00
LICENSE Added license. 2020-08-17 00:05:57 -07:00
middleware.js Added content security policy. 2022-07-31 23:29:47 -07:00
netlify.toml Fix geo lookup for Netlify. 2022-08-23 11:52:55 -07:00
next.config.js Updated test console. Refactored fetch for tracker. 2022-08-09 10:27:35 -07:00
package.json Merge pull request #1529 from ariaieboy/patch-1 2022-09-19 17:39:34 -07:00
postcss.config.js add rtl support 2021-05-13 09:15:37 +03:00
README.md Update README.md 2022-09-07 12:55:15 +10:00
rollup.tracker.config.js Fix tracker build for COLLECT_API_ENDPOINT. 2022-07-21 19:38:24 -07:00
yarn.lock Updated language bundles. 2022-09-12 14:36:27 -07:00

umami

Umami is a simple, fast, privacy-focused 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 version 12 or newer
  • A database. Umami supports MySQL and Postgresql databases.

Install Yarn

npm install -g yarn

Get the source code and install packages

git clone https://github.com/umami-software/umami.git
cd umami
yarn install

Configure umami

Create an .env file with the following

DATABASE_URL=connection-url

The connection url is in the following format:

postgresql://username:mypassword@localhost:5432/mydb

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

Build the application

yarn build

Create database tables

yarn update-db

This will also create a login account with username admin and password umami.

Start the application

yarn 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 docker.umami.is/umami-software/umami:postgresql-latest

Or with MySQL support:

docker pull docker.umami.is/umami-software/umami:mysql-latest

Getting updates

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

git pull
yarn install
yarn build

To update the Docker image, simply pull the new images and rebuild:

docker compose pull
docker compose up --force-recreate

License

MIT