Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2023-12-27 23:02:29 -08:00
.github Removed Node 16 from GH workflow. 2023-12-12 19:20:34 -08:00
.husky Fix build issues. 2021-11-22 14:53:36 -08:00
db Fix migrations to support mysql 5.7 2023-11-15 18:35:40 +01:00
docker Allow slashes in tracker names. 2023-04-20 01:52:49 -07:00
public replace all instances of publically with publicly 2023-12-27 23:02:29 -08:00
scripts Corrected error with port and hostname argument and added the extra empty array 2023-09-29 17:22:11 +02:00
src replace all instances of publically with publicly 2023-12-27 23:02:29 -08:00
.dockerignore Updated packages. 2023-04-21 14:39:06 -07:00
.eslintrc.json Updated clients. 2023-11-22 18:03:48 -08:00
.gitignore update ignore. 2023-09-21 16:45:46 -07:00
.prettierignore Updated packages. 2023-04-21 14:39:06 -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 Changed HASH_SALT to APP_SECRET. 2022-12-27 21:38:23 -08:00
docker-compose.yml Update Health Check 2023-11-27 16:25:53 +08:00
Dockerfile Update Health Check 2023-11-27 16:25:53 +08:00
jsconfig.json Added alias for public folder. 2023-08-22 03:36:49 -07:00
lang-ignore.json Merge pull request #2010 from RohrerF/swiss-german-translations 2023-05-04 14:21:19 -07:00
LICENSE Updated packages. 2022-12-26 20:50:55 -08:00
netlify.toml Adds @netlify/plugin-nextjs package & fixed dashboard link id 2022-10-25 15:01:49 +01:00
next-env.d.ts Fix CSS. Updated pages. 2023-09-29 19:18:44 -07:00
next.config.js Added SettingsContext. 2023-12-05 19:22:14 -08:00
package.components.json Fixed login redirect. 2023-09-21 18:37:40 -07:00
package.json Bump version 2.9.0. 2023-12-11 00:15:26 -08:00
postcss.config.js Removed rollup for components. 2023-04-21 13:16:54 -07:00
README.md Changed Docker URL. 2023-10-19 16:55:00 -07:00
rollup.components.config.mjs Fixed login redirect. 2023-10-04 16:36:47 -07:00
rollup.tracker.config.mjs Moved code into src folder. Added build for component library. 2023-08-21 02:06:09 -07:00
tsconfig.json Update ErrorBoundary. 2023-12-03 21:19:03 -08:00
yarn.lock Upgrade to Next 14. 2023-12-09 22:18:47 -08: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 16.13 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

The build step will also create tables in your database if you ae installing for the first time. It will also create a login user 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 -d

Alternatively, to pull just the Umami Docker image with PostgreSQL support:

docker pull ghcr.io/umami-software/umami:postgresql-latest

Or with MySQL support:

docker pull ghcr.io/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