kevinsivic/dawarich
1
0
Fork 0
mirror of https://github.com/Freika/dawarich.git synced 2026-01-10 01:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

update Synology and Docker documentation

Browse source
This commit is contained in:
andrei.ivnitskii@t-systems.com 2024-06-25 14:17:20 +02:00
parent e33cbebcf3
commit b0bbf5f63a
3 changed files with 14 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -85,20 +85,21 @@ You can import your Google Maps Timeline data into Dawarich as well as Owntracks
Press `Ctrl+C` to stop the app.
## How to deploy the app
## How to install the app
Copy the contents of the `docker-compose.yml` file to your server and run `docker-compose up`.
**[Docker](docs/Docker_install.md)**
**[Synology](docs/Synology_install.md)**
## Environment variables
| ENV var name | Description |
| ------------- | ------------- |
| MIN_MINUTES_SPENT_IN_CITY | minimum minutes between two points to consider them as visited the same city, e.g. `60` |
| MAP_CENTER | default map center, e.g. `[55.7522, 37.6156]` |
| TIME_ZONE | time zone, e.g. `Europe/Berlin`, full list is [here](https://github.com/Freika/dawarich/issues/27#issuecomment-2094721396) |
| APPLICATION_HOST | host of the application, e.g. `localhost` or `dawarich.example.com` |
| BACKGROUND_PROCESSING_CONCURRENCY (only for dawarich_sidekiq service) | Number of simultaneously processed background jobs, default is 10 |
| ENV var name | Description |
|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| MIN_MINUTES_SPENT_IN_CITY | minimum minutes between two points to consider them as visited the same city, e.g. `60` |
| MAP_CENTER | default map center, e.g. `[55.7522, 37.6156]` |
| TIME_ZONE | time zone, e.g. `Europe/Berlin`, full list is [here](https://github.com/Freika/dawarich/issues/27#issuecomment-2094721396) |
| APPLICATION_HOST | host of the application, e.g. `localhost` or `dawarich.example.com` |
| BACKGROUND_PROCESSING_CONCURRENCY (only for dawarich_sidekiq service) | Number of simultaneously processed background jobs, default is 10 |
## Star History

6
docs/Docker_install.md
View file

@ -2,10 +2,8 @@
> To do that you need previously install [Docker](https://docs.docker.com/get-docker/) on your system.
To quick Dawarich install run Docker-compose from project root folder
```shell
docker-compose up
```
To quick Dawarich install copy the contents of the `docker-compose.yml` file from project root folder to dedicated folder in your server and run `docker-compose up` in this folder.
This command use [docker-compose.yml](../docker-compose.yml) to build your local environment.
When this command done successfully and all services in containers will start you can open Dawarich web UI by this link [http://127.0.0.1:3000](http://127.0.0.1:3000).

2
docs/Synology_install.md
View file

@ -63,7 +63,7 @@ If you don't yet have DNS server you can install [Synology DNS](https://www.syno
### Dawarich
1. Open /[Docker root folder](#docker-root-share)/[Dawarich root folder](#dawarich-root-folder)/.env file in any text editor. For example, you can use [Text editor](https://www.synology.com/en-global/dsm/packages/TextEditor) package or download it from **File station**, edit locally and upload it back, or get access by file share.
2. Change `APPLICATION_HOST` value to your **Dawarich hostname** that you set in **Web station**. In example above **dawarich.my-syno.com**.
3. Set your current `TIME_ZONE`. Full list [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). See column **TZ identifier**
3. Set your current `TIME_ZONE`. Full list [here](https://github.com/Freika/dawarich/issues/27#issuecomment-2094721396).
4. Set `MAP_CENTER`. This is your default location. Open Google Maps, click to random point and copy coordinates from popup or address line.
5. Optionally change `DATABASE_USERNAME`, `DATABASE_USERNAME`, `DATABASE_NAME`.