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

Update readme

Browse source
This commit is contained in:
Eugene Burmakin 2024-09-08 15:09:08 +02:00
parent 254290ab9d
commit 63336f2126
3 changed files with 25 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGELOG.md
View file

@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/) The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/). and this project adheres to [Semantic Versioning](http://semver.org/).
## [0.13.5] — 2024-09-08
### Changed
- Default value for `RAILS_MAX_THREADS` was changed to 10.
## [0.13.4] — 2024-09-06 ## [0.13.4] — 2024-09-06
### Fixed ### Fixed

28
README.md
View file

@ -1,7 +1,8 @@
# Dawarich # Dawarich
[![Discord](https://dcbadge.limes.pink/api/server/pHsBjpt5J8)](https://discord.gg/pHsBjpt5J8) | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H3IDYDD) | [![Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dfreika%26type%3Dpatrons&style=for-the-badge)](https://www.patreon.com/freika) | [0x6bAd13667692632f1bF926cA9B421bEe7EaEB8D4](https://etherscan.io/address/0x6bAd13667692632f1bF926cA9B421bEe7EaEB8D4) [![Discord](https://dcbadge.limes.pink/api/server/pHsBjpt5J8)](https://discord.gg/pHsBjpt5J8) | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H3IDYDD) | [![Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dfreika%26type%3Dpatrons&style=for-the-badge)](https://www.patreon.com/freika)
Donate using crypto: [0x6bAd13667692632f1bF926cA9B421bEe7EaEB8D4](https://etherscan.io/address/0x6bAd13667692632f1bF926cA9B421bEe7EaEB8D4)
[![CircleCI](https://circleci.com/gh/Freika/dawarich.svg?style=svg)](https://app.circleci.com/pipelines/github/Freika/dawarich) [![CircleCI](https://circleci.com/gh/Freika/dawarich.svg?style=svg)](https://app.circleci.com/pipelines/github/Freika/dawarich)
@ -74,6 +75,12 @@ You can view your location history on a map. On the map you can enable/disable t
- Heatmap - Heatmap
- Points - Points
- Lines between points - Lines between points
- Fog of War
- Areas
### Visits (beta)
Dawarich can suggest places you've visited and allow you to confirm or reject them.
### Statistics ### Statistics
@ -86,9 +93,15 @@ You can import your existing location history from:
- Google Maps Timeline - Google Maps Timeline
- OwnTracks - OwnTracks
- Strava - Strava
- Immich
- Your own GPX files - Your own GPX files
- Your own GeoJSON files
- Your photos' EXIF data - Your photos' EXIF data
### Export
You can export your data to GeoJSON or GPX format.
## How to start the app locally ## How to start the app locally
`docker-compose up` to start the app. The app will be available at `http://localhost:3000`. `docker-compose up` to start the app. The app will be available at `http://localhost:3000`.
@ -97,9 +110,9 @@ Press `Ctrl+C` to stop the app.
## How to install the app ## How to install the app
**[Docker](docs/How_to_install_Dawarich_using_Docker.md)** **[Docker](https://dawarich.app/docs/intro#setup-your-dawarich-instance)**
**[Synology](docs/How_to_install_Dawarich_on_Synology.md)** **[Synology](https://dawarich.app/docs/tutorials/platforms/synology)**
### Default credentials ### Default credentials
@ -110,14 +123,7 @@ Feel free to change them both in the Account section.
## Environment variables ## Environment variables
| ENV var name | Description | See the docs on the [website](https://dawarich.app/docs/environment-variables-and-settings)
|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| MIN_MINUTES_SPENT_IN_CITY | minimum minutes between two points to consider them as visited the same city, e.g. `60` |
| TIME_ZONE | time zone, e.g. `Europe/Berlin`, full list is [here](https://github.com/Freika/dawarich/issues/27#issuecomment-2094721396) |
| APPLICATION_HOSTS | list of host of the application, e.g. `localhost,dawarich.example.com` |
| BACKGROUND_PROCESSING_CONCURRENCY (only for dawarich_sidekiq service) | Number of simultaneously processed background jobs, default is 10 |
| REVERSE_GEOCODING_ENABLED | `true` or `false`, this env var allows you to disable reverse geocoding feature entirely |
| PHOTON_API_HOST | Photon reverse geocoding api host. Useful, if you're running your own Photon instance |
## Star History ## Star History

2
config/database.yml
View file

@ -6,7 +6,7 @@ default: &default
password: <%= ENV['DATABASE_PASSWORD'] %> password: <%= ENV['DATABASE_PASSWORD'] %>
port: <%= ENV['DATABASE_PORT'] || '5432' %> port: <%= ENV['DATABASE_PORT'] || '5432' %>
host: <%= ENV['DATABASE_HOST'] %> host: <%= ENV['DATABASE_HOST'] %>
pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 10 } %>
timeout: 5000 timeout: 5000
development: development: