m/umami
1
0
Fork 0
mirror of https://github.com/kremalicious/umami.git synced 2024-11-15 09:45:04 +01:00
Code Issues Packages Projects Releases Wiki Activity
Umami is a simple, fast, privacy-focused alternative to Google Analytics.
97 Commits 2 Branches 0 Tags 16 MiB
TypeScript 89.7%
CSS 5.5%
JavaScript 4.5%
Dockerfile 0.3%
196652ffd5
Go to file
Mike Cao 196652ffd5 Add back db specific scripts.
2020-08-21 02:00:55 -07:00
assets Enable public website sharing. 2020-08-15 01:17:15 -07:00
components Fix error message on login. 2020-08-19 19:03:42 -07:00
hooks Added user button and menu. 2020-08-05 23:03:07 -07:00
lib Format long numbers. Updated README. 2020-08-19 14:35:38 -07:00
pages Fix not found appearing on share pages. 2020-08-19 14:42:54 -07:00
prisma Enable public website sharing. 2020-08-15 01:17:15 -07:00
public Moved cli to separate project. Separate database schemas. 2020-08-13 01:41:11 -07:00
redux Implement redux. 2020-08-04 22:45:05 -07:00
scripts Removed unused file. 2020-08-21 01:46:55 -07:00
sql Update password hashes. 2020-08-19 03:16:02 -07:00
styles Show active visitor count. 2020-08-18 00:51:32 -07:00
tracker Created cli command. Updated tracker script. 2020-07-23 22:07:57 -07:00
.eslintrc.json Added world map component. 2020-08-01 03:34:56 -07:00
.gitignore Database build script. 2020-08-19 20:51:35 -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 Initial commit. 2020-07-17 01:03:38 -07:00
jsconfig.json Initial commit. 2020-07-17 01:03:38 -07:00
LICENSE Added license. 2020-08-17 00:05:57 -07:00
next.config.js Initial commit. 2020-07-17 01:03:38 -07:00
package.json Add back db specific scripts. 2020-08-21 02:00:55 -07:00
postcss.config.js Initial commit. 2020-07-17 01:03:38 -07:00
README.md Database build script. 2020-08-19 20:51:35 -07:00
rollup.tracker.config.js Build cli using rollup. 2020-07-24 17:00:56 -07:00
yarn.lock New build process. 2020-08-21 01:45:44 -07:00

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/

Installation

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.

Generate database client

npm run build-db-client

Create a production build

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.

License

MIT