Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2022-03-16 21:50:24 -07:00
.github Update docker login 2021-04-08 21:49:41 -07:00
.husky Fix build issues. 2021-11-22 14:53:36 -08:00
assets Added website limit and show more button. Closes #592. 2022-03-01 23:03:50 -08:00
components Mobile css updates. 2022-03-11 16:04:05 -08:00
hooks Added website limit and show more button. Closes #592. 2022-03-01 23:03:50 -08:00
lang Updated language files. 2022-03-04 18:20:13 -08:00
lib Update session hash calculation. 2022-03-14 11:14:05 -07:00
pages Fix issue with force SSL redirects. 2022-03-15 08:49:42 -07:00
prisma Change to synchronous password hashing. 2021-05-23 17:29:27 -07:00
public Updated language files. 2022-03-04 18:20:13 -08:00
scripts Added telemetry script. 2022-03-16 21:50:24 -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 Added language and theme settings. 2022-02-28 20:54:32 -08:00
tracker Added css-events tracker parameter. Closes #1018. 2022-03-10 23:04:05 -08:00
.dockerignore for better local building performance 2020-08-23 14:07:01 +12:00
.eslintrc.json Fix eslint plugin issue. 2022-03-11 22:26:58 -08: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 Added telemetry script. 2022-03-16 21:50:24 -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 Updated readme. 2021-07-16 00:07:43 -07:00
rollup.tracker.config.js Fix tracker build. 2022-03-02 12:10:47 -08:00
yarn.lock Added telemetry script. 2022-03-16 21:50:24 -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

License

MIT