Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
Mike Cao 29a2ca0c26
Merge pull request #2096 from IMS-Network/fix-1966-issue-IDN
fix DOMAIN_REGEX for .ישראל IDN's to work :)
2023-07-10 08:50:23 -07:00
.github remove enhancement label from github issues 2023-06-28 18:50:47 -07:00
.husky Fix build issues. 2021-11-22 14:53:36 -08:00
assets Metrics components refactoring. New event data page. 2023-07-10 04:35:19 -07:00
components Show event data values. 2023-07-10 05:46:45 -07:00
db Fix numeric to number. 2023-07-06 21:02:56 -07:00
docker Allow slashes in tracker names. 2023-04-20 01:52:49 -07:00
hooks Metrics components refactoring. New event data page. 2023-07-10 04:35:19 -07:00
lang Merge branch 'dev' into master 2023-06-29 17:10:06 -07:00
lib Merge pull request #2096 from IMS-Network/fix-1966-issue-IDN 2023-07-10 08:50:23 -07:00
pages Metrics components refactoring. New event data page. 2023-07-10 04:35:19 -07:00
public Metrics components refactoring. New event data page. 2023-07-10 04:35:19 -07:00
queries Show event data values. 2023-07-10 05:46:45 -07:00
scripts Update check-env for CI build. 2023-05-16 21:13:17 -07:00
store Added report context. Removed report store. 2023-05-28 21:37:34 -07:00
styles checkpoint 2023-05-18 11:17:35 -07:00
tracker chore(tracker): 🏷️ could not use string in EventData 2023-06-03 00:36:04 +02:00
.dockerignore Updated packages. 2023-04-21 14:39:06 -07:00
.eslintrc.json POC for exporting components. 2023-04-21 12:43:37 -07:00
.gitignore POC for exporting components. 2023-04-21 12:43:37 -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 Merge pull request #2027 from theshamuel/patch-2 2023-05-12 18:57:08 -07:00
Dockerfile Added middleware for docker. 2023-04-19 08:49:16 -07:00
jsconfig.json Initial commit. 2020-07-17 01:03:38 -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 Updated login form. 2022-11-28 11:14:24 -08:00
next.config.js Fixed CSP issue, renamed var to ALLOWED_FRAME_URLS. 2023-06-29 19:38:35 -07:00
package.json Merge pull request #2096 from IMS-Network/fix-1966-issue-IDN 2023-07-10 08:50:23 -07:00
postcss.config.js Removed rollup for components. 2023-04-21 13:16:54 -07:00
README.md Merge branch 'dev' 2023-04-17 11:08:17 -07:00
rollup.tracker.config.js Fixed tracker config. 2023-05-30 19:58:28 -07:00
tsconfig.json Revert tsconfig.json. 2023-04-21 16:06:49 -07:00
yarn.lock Metrics components refactoring. New event data page. 2023-07-10 04:35:19 -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

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

Or with MySQL support:

docker pull docker.umami.dev/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