mirror of
https://github.com/kremalicious/umami.git
synced 2024-06-28 00:37:51 +02:00
dfae0c150d
# Conflicts: # components/common/Calendar.js # components/common/EventDataButton.js # components/forms/EventDataForm.js # components/layout/Header.js # db/mysql/migrations/02_add_event_data/migration.sql # lang/be-BY.json # lang/de-CH.json # lang/es-MX.json # lang/fa-IR.json # lang/km-KH.json # lang/lt-LT.json # lang/th-TH.json # lib/auth.js # lib/detect.ts # lib/lang.js # lib/middleware.js # lib/prisma.js # package.json # pages/_app.js # pages/api/accounts/[id]/password.js # pages/api/collect.js # pages/api/realtime/init.js # pages/api/websites/[id]/index.js # pages/api/websites/[id]/reset.ts # pages/api/websites/index.js # public/intl/messages/fa-IR.json # public/intl/messages/lt-LT.json # public/intl/messages/pt-BR.json # public/intl/messages/th-TH.json # queries/analytics/event/getEventData.js # queries/analytics/event/getEventMetrics.js # queries/analytics/pageview/getPageviewMetrics.js # queries/analytics/pageview/getPageviewParams.js # queries/analytics/pageview/getPageviewStats.js # queries/analytics/session/getSessionMetrics.js # queries/analytics/stats/getActiveVisitors.js # queries/analytics/stats/getWebsiteStats.js # sql/schema.mysql.sql # styles/index.css # yarn.lock
104 lines
2.1 KiB
Markdown
104 lines
2.1 KiB
Markdown
# 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/](https://umami.is/docs/)
|
|
|
|
## Installing from source
|
|
|
|
### Requirements
|
|
|
|
- A server with Node.js version 12 or newer
|
|
- A database. Umami supports [MySQL](https://www.mysql.com/) and [Postgresql](https://www.postgresql.org/) 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
|
|
|
|
```bash
|
|
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 user with username **admin** and password **umami**.
|
|
|
|
### Start the application
|
|
|
|
```bash
|
|
yarn start
|
|
```
|
|
|
|
By default this will launch the application on `http://localhost:3000`. You will need to either
|
|
[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server
|
|
or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.
|
|
|
|
## Installing with Docker
|
|
|
|
To build the umami container and start up a Postgres database, run:
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
Alternatively, to pull just the Umami Docker image with PostgreSQL support:
|
|
|
|
```bash
|
|
docker pull docker.umami.dev/umami-software/umami:postgresql-latest
|
|
```
|
|
|
|
Or with MySQL support:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
git pull
|
|
yarn install
|
|
yarn build
|
|
```
|
|
|
|
To update the Docker image, simply pull the new images and rebuild:
|
|
|
|
```bash
|
|
docker compose pull
|
|
docker compose up --force-recreate
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|