Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2022-04-09 22:20:37 +08:00
.github Update language bundles. 2022-04-03 20:19:05 -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 Allow user to change admin username. 2022-04-03 22:25:32 -07:00
hooks Refactored localization files. 2022-03-18 19:17:23 -07:00
lang Merge pull request #1 from Lemonawa/patch-2 2022-04-09 22:20:37 +08:00
lib Allow user to change admin username. 2022-04-03 22:25:32 -07:00
pages Added CORS to website API endpoints. 2022-04-04 00:33:20 -07:00
prisma Update prisma seed files. 2022-03-31 19:25:04 -07:00
public Update language bundles. 2022-04-03 20:19:05 -07:00
scripts Added previous version to payload. 2022-03-18 22:52:42 -07:00
sql Fix charset issues on mySQL (fixes #388) 2020-11-28 00:42:00 +01:00
store New Dashboard component. 2022-03-03 19:45:49 -08:00
styles Updated next and prisma. 2022-04-02 21:07:08 -07:00
tracker Enabling caching in tracker script. 2022-03-18 22:26:23 -07:00
.dockerignore for better local building performance 2020-08-23 14:07:01 +12:00
.eslintrc.json Cleaned up eslint config. 2022-03-18 19:02:06 -07:00
.gitignore Added lt-LT and ur-PK languages. Changed lang build. 2022-02-15 20:34:16 -08: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 Initial commit. 2020-07-17 01:03:38 -07:00
app.json Added app.json for heroku 2021-11-01 18:19:48 +05:30
docker-compose.yml Consider adding restart policy to docker-compose.yml 2021-07-10 17:05:01 +08:00
Dockerfile Move environment variables to middleware. Closes #972. 2022-02-20 23:27:50 -08:00
jsconfig.json Initial commit. 2020-07-17 01:03:38 -07:00
lang-ignore.json Fix check-lang script. Ignore all en-GB. 2022-03-02 22:23:03 -08:00
LICENSE Added license. 2020-08-17 00:05:57 -07:00
netlify.toml add netlify.toml 2022-02-19 17:15:44 -06:00
next.config.js Updated matching for different tracker names. 2022-02-27 02:53:24 -08:00
package.json Fix for docker build. 2022-04-04 04:07:01 -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 Added Docker updating notes 2022-03-17 13:51:24 -06:00
rollup.tracker.config.js Fix tracker build. 2022-03-02 12:10:47 -08:00
yarn.lock Update dependencies. 2022-04-04 03:43:29 -07:00

umami

Umami is a simple, fast, website analytics 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 12 or newer
  • A database (MySQL or Postgresql)

Get the source code and install packages

git clone https://github.com/mikecao/umami.git
cd umami
npm install

Create database tables

Umami supports MySQL and Postgresql. Create a database for your Umami installation and install the tables with the included scripts.

For MySQL:

mysql -u username -p databasename < sql/schema.mysql.sql

For Postgresql:

psql -h hostname -U username -d databasename -f sql/schema.postgresql.sql

This will also create a login account with username admin and password umami.

Configure umami

Create an .env file with the following

DATABASE_URL=(connection url)
HASH_SALT=(any random string)

The connection url is in the following format:

postgresql://username:mypassword@localhost:5432/mydb

mysql://username:mypassword@localhost:3306/mydb

The HASH_SALT is used to generate unique values for your installation.

Build the application

npm run build

Start the application

npm 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 ghcr.io/mikecao/umami:postgresql-latest

Or with MySQL support:

docker pull ghcr.io/mikecao/umami:mysql-latest

Getting updates

To get the latest features, simply do a pull, install any new dependencies, and rebuild:

git pull
npm install
npm run build

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

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

License

MIT