Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2022-07-21 19:52:32 -07:00
.github Update lang. Remove node 12 test. 2022-07-15 23:57:44 -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 Remove unused prop on UTM table 2022-07-21 19:52:32 -07:00
db Upgrade to Prisma 4. 2022-07-14 22:57:38 -07:00
hooks Updated version checking. 2022-06-24 01:54:55 -07:00
lang Add UTM params to website details page 2022-07-21 16:22:43 -07:00
lib Refactored referrer logic. Display stats for no referrers. 2022-07-21 01:11:10 -07:00
pages Add UTM pageview metrics to API 2022-07-21 14:57:29 -07:00
public Refactored referrer logic. Display stats for no referrers. 2022-07-21 01:11:10 -07:00
queries Fix UTM query, move filters to proper place 2022-07-21 16:56:57 -07:00
scripts Clean-up. 2022-06-27 23:08:58 -07:00
sql Unify database changes. Closes #1264 2022-07-06 20:45:53 -07:00
store Allow custom release URL. 2022-07-15 23:53:31 -07:00
styles Updated next and prisma. 2022-04-02 21:07:08 -07:00
tracker Update tracker/index.js: SendBeacon() to Fetch API 2022-05-22 23:18:26 +05:30
.dockerignore for better local building performance 2020-08-23 14:07:01 +12:00
.eslintrc.json Allow custom release URL. 2022-07-15 23:53:31 -07:00
.gitignore Refactor migrations. 2022-06-19 00:07:01 -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 Run migrations on start 2022-06-12 08:38:58 +02:00
docker-compose.yml Consider adding restart policy to docker-compose.yml 2021-07-10 17:05:01 +08:00
Dockerfile Update docker build. 2022-06-27 10:34:03 -07:00
jsconfig.json Initial commit. 2020-07-17 01:03:38 -07:00
lang-ignore.json Updated language bundles. 2022-04-12 21:49:17 -07:00
LICENSE Added license. 2020-08-17 00:05:57 -07:00
middleware.js Moved middleware. 2022-07-07 09:24:32 -07:00
netlify.toml add netlify.toml 2022-02-19 17:15:44 -06:00
next.config.js Allow custom release URL. 2022-07-15 23:53:31 -07:00
package.json Updated packages. Prisma 4.1.0. 2022-07-20 16:42:31 -07:00
postcss.config.js add rtl support 2021-05-13 09:15:37 +03:00
Procfile Add Procfile to tell Heroku how to start the app 2020-10-25 22:58:56 +00:00
README.md Update docker urls. 2022-07-16 22:04:53 -07:00
rollup.tracker.config.js Change API_COLLECT_ENDPOINT to COLLECT_API_ENDPOINT 2022-07-04 15:52:59 +05:30
yarn.lock Updated packages. Prisma 4.1.0. 2022-07-20 16:42:31 -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/mikecao/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
yarn update-db

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

docker-compose pull
docker-compose up --force-recreate

License

MIT