mirror of
https://github.com/Freika/dawarich.git
synced 2026-01-10 17:21:38 -05:00
Evgenii Burmakin
GitHub
commit
bc23b7db42
7 changed files with 262 additions and 10 deletions
21
README.md
21
README.md
|
|
@ -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
|
||||
|
||||
|
|
|
|||
9
docs/Docker_install.md
Normal file
9
docs/Docker_install.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# Docker installation
|
||||
|
||||
> To do that you need previously install [Docker](https://docs.docker.com/get-docker/) on your system.
|
||||
|
||||
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).
|
||||
121
docs/Synology_install.md
Normal file
121
docs/Synology_install.md
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
# Preparation
|
||||
|
||||
## Container manager
|
||||
Firstly you need install [Container manager](https://www.synology.com/en-global/dsm/feature/container-manager) on your DSM.
|
||||
|
||||
- Open Synology DSM web UI.
|
||||
- In the main menu open **Package Center**.
|
||||
- Search **Container Manager** in the "open source" section.
|
||||
- Install that.
|
||||
|
||||
## Web station
|
||||
Do same for [Web station](https://www.synology.com/en-global/dsm/packages/WebStation) packet.
|
||||
|
||||
## Project folder preparation
|
||||
|
||||
### Docker root share
|
||||
If you don't yet have separated share for docker projects would be good to create it.
|
||||
|
||||
If you don't want to use dedicated share for projects installed by docker skip it and go to next chapter.
|
||||
|
||||
- Open **Control panel** -> **Shared folder** -> **Create** -> **Create shared folder**
|
||||
- Set name, for example **docker**, and location.
|
||||
- Check **Hide this shared folder in "My Network Places"**. This hide this folder from listening by smb, afp, ftp shares.
|
||||
- Click **Next** several times until you see **Configure user permissions** window.
|
||||
- Check **Read/write** access for your user and **No Access** for all another.
|
||||
|
||||
### Dawarich root folder
|
||||
1. Open your [Docker root folder](#docker-root-share) in **File station**.
|
||||
2. Create new folder **dawarich** and open it.
|
||||
3. Create folders **redis**, **db_data**, **db_shared**, **gem_cache** and **gem_cache** in **dawarich** folder.
|
||||
4. Copy [docker compose](synology/docker-compose.yml) and [.env](synology/.env) files form **synology** repo folder into **dawarich** folder on your synology.
|
||||
|
||||
# Installation
|
||||
|
||||
## Project create
|
||||
1. Open **Container Manager** -> **Projects** -> **Create**
|
||||
2. In **create project window**.
|
||||
1. Set **project name** as you wish.
|
||||
2. Set **path** to [Dawarich root folder](#dawarich-root-folder).
|
||||
1. DSM ask about existed docker compose file, choose **use existing an docker-compose.yml to create the project**.
|
||||
3. Click **Next**.
|
||||
4. Check **Set up web portal via Web Station**.
|
||||
1. Select container name, port and **http** protocol (not https).
|
||||
5. Click "Next".
|
||||
6. Uncheck **Start the project once it is created**.
|
||||
7. Click "Done".
|
||||
3. In popup "dawarich has been created. Go to Web Station to configure the web portal for the container." click "OK". **Web station** Portal Creation Wizard will be opened.
|
||||
4. Set **portal type** to **Name-based**.
|
||||
5. Set **hostname** as your wish. For example if your DSM have hostname **my-syno.com**, you can use **dawarich.my-syno.com**.
|
||||
6. Check **HTTPS settings - HSTS**
|
||||
>I expected that you have configured certificate in DSM . See **Control panel** -> **Security** -> **Certificate**. For example previously you configured **QuickConnect** or **DynDNS** (DDNS). See **Control panel** -> **External Access**
|
||||
7. Click **Create**.
|
||||
|
||||
## Configuration
|
||||
### DNS
|
||||
On your local DNS server you need to add new record with `dawarich.my-syno.com` and ip address of Synology (see **Control panel** -> **Network** -> **Network Interface** in your DSM) to provide correct access to Dawarich, or just use wildcard `*.my-syno.com` record to resolve all subdomains `my-syno.com` to Synology ip.
|
||||
|
||||
Please read documentation of your DNS server understand how to do it.
|
||||
|
||||
If you don't yet have DNS server you can install [Synology DNS](https://www.synology.com/en-global/dsm/packages/DNSServer) .
|
||||
>Don't forget to reconfigure your DHCP server or all device settings in your local network to use this DNS server.
|
||||
|
||||
### 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://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`.
|
||||
|
||||
6. Click on name of your project.
|
||||
7. Open **YAML Configurations** tab.
|
||||
|
||||
# Run
|
||||
1. Open **Container Manager** -> **Projects** ->**dawarich**
|
||||
2. In top right corner click **Action** -> **Build**
|
||||
3. Wait until popup writes that all done and wait a few minutes more until all apps in containers starts.
|
||||
4. Open it by your hostname. In this example https://dawarich.my-syno.com
|
||||
|
||||
# Link in the Main menu
|
||||
There two possible options:
|
||||
1. With **Web station**. But you will have default web station icon.
|
||||
2. With custom application for **Package Center**.
|
||||
## Web station
|
||||
- Open **Web station** -> **Web Portal** -> **dawarich (project)**.
|
||||
- Check **Create shortcut on main menu** and set link name.
|
||||
|
||||
## Custom application
|
||||
Synology allows you to create custom application and install them by **Package Center**
|
||||
[Here](https://github.com/vletroye/Mods) you can find tool that creates dummy application only with icon on main menu.
|
||||
You can use this tool and create your own app, or use prepared one in this repo. But you need to change url to Dawarich inside it.
|
||||
|
||||
- Edit `update.sh` from `synology` folder. And in the first lines set correct values for `author` and `URL`.
|
||||
- Run `update.sh`. When script finish you will see the `spk` and `Dawarich.spk` in the same folder.
|
||||
|
||||
If you don't have linux console you can create temporal docker project to generate spk package.
|
||||
- Create new folder in [Docker root folder](#docker-root-share).
|
||||
- Create subfolder `app` and copy `update.sh` and `spk.tgz` into this subfolder.
|
||||
- Open **Container Manager** -> **Projects** -> **Create**.
|
||||
- Set any name, set newly created folder and set **Create docker-compose.yml**.
|
||||
- Copy text below to text field.
|
||||
```yaml
|
||||
name: spk-template
|
||||
|
||||
services:
|
||||
spk-template:
|
||||
container_name: spk-template
|
||||
image: alpine
|
||||
restart: unless-stopped
|
||||
working_dir: /app
|
||||
volumes:
|
||||
- ./app:/app
|
||||
command:
|
||||
- /app/update.sh
|
||||
```
|
||||
- Click **Next**, **Next**, **Done**
|
||||
- Container should run and finish automatically.
|
||||
- After that you can see `spk` and `Dawarich.spk` in the `app` folder.
|
||||
|
||||
|
||||
- Check `url` in `spk/package/ui/config` file and `maintainer` and `distributor` in `spk/INFO` file.
|
||||
- Open **Package Center**, click to **Manual Install**,select `Dawarich.spk`, agree with security notice, and install it.
|
||||
25
docs/synology/.env
Normal file
25
docs/synology/.env
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
###################################################################################
|
||||
# Dawarich
|
||||
###################################################################################
|
||||
|
||||
RAILS_ENV=development
|
||||
MIN_MINUTES_SPENT_IN_CITY=60
|
||||
APPLICATION_HOST=dawarich.djhrum.synology.me
|
||||
TIME_ZONE=Europe/Berlin
|
||||
BACKGROUND_PROCESSING_CONCURRENCY=10
|
||||
MAP_CENTER=[52.520826, 13.409690]
|
||||
|
||||
###################################################################################
|
||||
# Database
|
||||
###################################################################################
|
||||
|
||||
DATABASE_HOST=dawarich_db
|
||||
DATABASE_USERNAME=postgres
|
||||
DATABASE_PASSWORD=password
|
||||
DATABASE_NAME=dawarich
|
||||
|
||||
###################################################################################
|
||||
# Redis
|
||||
###################################################################################
|
||||
|
||||
REDIS_URL=redis://dawarich_redis:6379/0
|
||||
56
docs/synology/docker-compose.yml
Normal file
56
docs/synology/docker-compose.yml
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
version: '3'
|
||||
|
||||
services:
|
||||
dawarich_redis:
|
||||
image: redis:7.0-alpine
|
||||
container_name: dawarich_redis
|
||||
command: redis-server
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- ./redis:/var/shared/redis
|
||||
|
||||
dawarich_db:
|
||||
image: postgres:14.2-alpine
|
||||
container_name: dawarich_db
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_USER: ${DATABASE_USERNAME}
|
||||
POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
|
||||
volumes:
|
||||
- ./db_data:/var/lib/postgresql/data
|
||||
- ./db_shared:/var/shared
|
||||
|
||||
dawarich_app:
|
||||
image: freikin/dawarich:latest
|
||||
container_name: dawarich_app
|
||||
depends_on:
|
||||
- dawarich_db
|
||||
- dawarich_redis
|
||||
stdin_open: true
|
||||
tty: true
|
||||
entrypoint: dev-entrypoint.sh
|
||||
command: ['bin/dev']
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- .env
|
||||
volumes:
|
||||
- ./gem_cache:/usr/local/bundle/gems
|
||||
- ./public:/var/app/public
|
||||
ports:
|
||||
- 32568:3000
|
||||
|
||||
dawarich_sidekiq:
|
||||
image: freikin/dawarich:latest
|
||||
container_name: dawarich_sidekiq
|
||||
depends_on:
|
||||
- dawarich_db
|
||||
- dawarich_redis
|
||||
- dawarich_app
|
||||
entrypoint: dev-entrypoint.sh
|
||||
command: ['sidekiq']
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- .env
|
||||
volumes:
|
||||
- ./gem_cache:/usr/local/bundle/gems
|
||||
- ./public:/var/app/public
|
||||
BIN
docs/synology/spk.tgz
Normal file
BIN
docs/synology/spk.tgz
Normal file
Binary file not shown.
40
docs/synology/update.sh
Normal file
40
docs/synology/update.sh
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
#!/bin/sh
|
||||
|
||||
author="your name"
|
||||
URL="https://your.dawarich.domain.com"
|
||||
|
||||
|
||||
if [[ -d spk ]]
|
||||
then
|
||||
rm -rf spk
|
||||
fi
|
||||
|
||||
if [[ -f Dawarich.spk ]]
|
||||
then
|
||||
rm -rf Dawarich.spk
|
||||
fi
|
||||
|
||||
tar -xf spk.tgz
|
||||
|
||||
if [[ -f package.tgz ]]
|
||||
then
|
||||
rm -f package.tgz
|
||||
fi
|
||||
|
||||
sed -i "s/maintainer=\"\"/maintainer=\"${author}\"/" spk/INFO
|
||||
sed -i "s/distributor=\"\"/distributor=\"${author}\"/" spk/INFO
|
||||
sed -i "s|https://dawarich.my-syno.com|${URL}|" spk/package/ui/config
|
||||
|
||||
cd spk/package
|
||||
|
||||
tar -czf ../package.tgz *
|
||||
|
||||
cd ..
|
||||
|
||||
sum=$(md5sum package.tgz | cut -f1 -d" ")
|
||||
|
||||
sed -i "s/checksum=\"\"/checksum=\"${sum}\"/" INFO
|
||||
|
||||
tar -cf ../Dawarich.spk package.tgz conf scripts INFO PACKAGE_ICON*.PNG
|
||||
|
||||
cd ..
|
||||
Loading…
Reference in a new issue