Umami is a simple, fast, privacy-focused alternative to Google Analytics.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Matthias Kretschmann 68de243fd1
Merge branch 'umami-software:master' into master
1 week ago
.github styling updates 3 months ago
.husky Fix build issues. 1 year ago
assets styling updates 3 months ago
components Merge branch 'umami-software:master' into master 1 week ago
db add current databasefilter when querying index 2 weeks ago
hooks Fix issue with generating URLs. 5 months ago
lang Updated language files. 2 weeks ago
lib Merge branch 'umami-software:master' into master 1 week ago
pages Merge branch 'umami-software:master' into master 1 week ago
public Merge branch 'umami-software:master' into master 1 week ago
queries Fix share URL permissions. (#1745) 3 weeks ago
scripts update check-db 4 months ago
sql Unify database changes. Closes #1264 7 months ago
store Use next-basics package. 5 months ago
styles Merge branch 'umami-software:master' into master 1 week ago
tracker Add guard around location redirect. 3 months ago
.dockerignore for better local building performance 2 years ago
.eslintrc.json Use next-basics package. 5 months ago
.gitignore fix clickhouse calls (#1536) 4 months ago
.prettierignore Add indexes to tables. 3 years ago
.prettierrc.json Initial commit. 3 years ago
.stylelintrc.json Update readme. 10 months ago
Dockerfile Run migration on build 6 months ago
LICENSE Added license. 3 years ago
README.md Update docker server url. 3 months ago
app.json Update the links for current repository 7 months ago
docker-compose.yml Update the links for current repository 7 months ago
jsconfig.json Initial commit. 3 years ago
lang-ignore.json Merge pull request #1381 from winterrific/master 6 months ago
middleware.js Added content security policy. 6 months ago
netlify.toml Adds @netlify/plugin-nextjs package & fixed dashboard link id 3 months ago
next.config.js checkpoint 4 months ago
package.json Bump version v1.40.0. 2 weeks ago
postcss.config.js add rtl support 2 years ago
rollup.tracker.config.js Fix tracker build for COLLECT_API_ENDPOINT. 7 months ago
yarn.lock Bump version v1.40.0. 2 weeks ago

README.md

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 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.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