Umami is a simple, fast, website analytics alternative to Google Analytics. https://github.com/mikecao/umami https://umami.is/
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.
 
 
 
 
Mike Cao 5e57b26e46 Convert buttons to links. 1 year ago
.github Convert buttons to links. 1 year ago
assets Calendar updates. Responsive CSS updates. 1 year ago
components Convert buttons to links. 1 year ago
hooks Added useLocale hook. 1 year ago
lang Convert buttons to links. 1 year ago
lib Update locale files and scripts. 1 year ago
pages Fix 401 on share url. 1 year ago
prisma Enable public website sharing. 1 year ago
public Add tracker build to main build. 1 year ago
redux Rename en to en-US. 1 year ago
scripts Update locale files and scripts. 1 year ago
sql MySQL query optimization. Added loading component. 1 year ago
styles Convert buttons to links. 1 year ago
tracker Update url checking logic. 1 year ago
.dockerignore for better local building performance 1 year ago
.eslintrc.json Updated pages and referrer filters to merge urls. 1 year ago
.gitignore New language build process. 1 year ago
.prettierignore Add indexes to tables. 1 year ago
.prettierrc.json Initial commit. 1 year ago
.stylelintrc.json Initial commit. 1 year ago
Dockerfile Add DATABASE_TYPE environment variable 1 year ago
LICENSE Added license. 1 year ago
README.md Added page not found string. 1 year ago
docker-compose.yml Use GitHub Container Registry for Docker images 1 year ago
jsconfig.json Initial commit. 1 year ago
next.config.js Added version to footer. CSS and locale fixes. 1 year ago
package.json Fix 401 on share url. 1 year ago
postcss.config.js Initial commit. 1 year ago
rollup.tracker.config.js Refactor do not track code. 1 year ago
yarn.lock Added check for bots. 1 year ago

README.md

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