Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2023-01-27 21:53:13 -08: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 More refactoring, cleaned up icons, nav buttons, add messages. 2023-01-27 21:53:13 -08:00
components More refactoring, cleaned up icons, nav buttons, add messages. 2023-01-27 21:53:13 -08:00
db update check-db, add pgcrypto extension if not exists on init migration 2023-01-20 14:21:11 -08:00
hooks Refactored layout. Added NavBar component. 2023-01-18 15:05:39 -08:00
lang Update pl-PL.json 2022-10-27 19:01:36 +02:00
lib Add maxAge config to cache CORS preflight request 2023-01-19 18:06:18 +08:00
pages Refactored intl messages. 2023-01-25 07:42:46 -08:00
public Bump version v1.39.4. Updated packages, languages. 2022-10-31 20:30:02 -07:00
queries Refactored intl messages. 2023-01-25 07:42:46 -08:00
scripts fix checkDatabaseVersion message typo 2023-01-23 10:06:52 -08:00
store Use next-basics package. 2022-08-28 20:20:54 -07:00
styles Refactored layout. Added NavBar component. 2023-01-18 15:05:39 -08:00
tracker Fix event var names. 2022-12-26 23:21:54 -08: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 Changed HASH_SALT to APP_SECRET. 2022-12-27 21:38:23 -08:00
docker-compose.yml Changed HASH_SALT to APP_SECRET. 2022-12-27 21:38:23 -08: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 Updated packages. 2022-12-26 20:50:55 -08:00
middleware.js Added content security policy. 2022-07-31 23:29:47 -07:00
netlify.toml Adds @netlify/plugin-nextjs package & fixed dashboard link id 2022-10-25 15:01:49 +01:00
next-env.d.ts Dev (#1702) 2022-12-12 19:45:38 -08:00
next.config.js Dev (#1702) 2022-12-12 19:45:38 -08:00
package.json More refactoring, cleaned up icons, nav buttons, add messages. 2023-01-27 21:53:13 -08:00
postcss.config.js Refactored layout. Added NavBar component. 2023-01-18 15:05:39 -08:00
README.md Merge branch 'dev' into analytics 2022-11-10 12:27:36 -08:00
rollup.tracker.config.js Fix tracker build for COLLECT_API_ENDPOINT. 2022-07-21 19:38:24 -07:00
tsconfig.json Dev (#1702) 2022-12-12 19:45:38 -08:00
yarn.lock More refactoring, cleaned up icons, nav buttons, add messages. 2023-01-27 21:53:13 -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 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

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