umami/README.md

104 lines
2.1 KiB
Markdown
Raw Normal View History

# umami
2022-04-08 03:15:45 +02:00
Umami is a simple, fast, privacy-focused alternative to Google Analytics.
2020-08-19 23:35:38 +02:00
## Getting started
A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/)
## Installing from source
2020-08-19 23:35:38 +02:00
### Requirements
2022-06-19 09:07:01 +02:00
- 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.
2020-08-19 23:35:38 +02:00
2022-06-19 09:07:01 +02:00
### Install Yarn
2022-05-25 06:33:38 +02:00
```
npm install -g yarn
```
2020-08-20 05:51:35 +02:00
### Get the source code and install packages
```
git clone https://github.com/umami-software/umami.git
cd umami
yarn install
2020-08-17 06:28:54 +02:00
```
### Configure umami
Create an `.env` file with the following
```
2022-07-17 07:04:53 +02:00
DATABASE_URL=connection-url
```
The connection url is in the following format:
2022-11-01 07:42:37 +01:00
```
postgresql://username:mypassword@localhost:5432/mydb
mysql://username:mypassword@localhost:3306/mydb
```
2022-06-22 18:34:03 +02:00
### Build the application
2022-06-19 09:07:01 +02:00
```bash
2022-06-22 18:34:03 +02:00
yarn build
2022-06-19 09:07:01 +02:00
```
2022-11-01 07:42:37 +01:00
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**.
2022-06-27 11:41:31 +02:00
2020-08-17 06:28:54 +02:00
### Start the application
```bash
2022-05-25 06:33:38 +02:00
yarn start
2020-08-17 06:28:54 +02:00
```
2022-06-12 08:38:58 +02:00
By default this will launch the application on `http://localhost:3000`. You will need to either
2020-08-17 06:28:54 +02:00
[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server
2020-08-17 09:05:57 +02:00
or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.
## Installing with Docker
2020-08-19 06:23:04 +02:00
To build the umami container and start up a Postgres database, run:
```bash
2023-03-30 20:34:11 +02:00
docker compose up -d
2020-08-19 06:23:04 +02:00
```
Alternatively, to pull just the Umami Docker image with PostgreSQL support:
2022-11-01 07:42:37 +01:00
```bash
2022-11-03 16:52:47 +01:00
docker pull docker.umami.dev/umami-software/umami:postgresql-latest
```
Or with MySQL support:
2022-11-01 07:42:37 +01:00
```bash
2022-11-03 16:52:47 +01:00
docker pull docker.umami.dev/umami-software/umami:mysql-latest
```
2020-09-04 01:32:09 +02:00
## Getting updates
2020-09-03 17:56:51 +02:00
To get the latest features, simply do a pull, install any new dependencies, and rebuild:
```bash
2020-09-03 17:56:51 +02:00
git pull
2022-05-25 06:33:38 +02:00
yarn install
yarn build
2020-09-03 17:56:51 +02:00
```
2022-03-17 20:51:24 +01:00
To update the Docker image, simply pull the new images and rebuild:
```bash
docker compose pull
docker compose up --force-recreate
2022-03-17 20:51:24 +01:00
```
2020-08-17 09:05:57 +02:00
## License
MIT