mirror of
https://github.com/Freika/dawarich.git
synced 2026-01-10 17:21:38 -05:00
Update readme
This commit is contained in:
Eugene Burmakin
parent
1a0d68ab58
commit
31e7eff23a
1 changed files with 96 additions and 97 deletions
193
README.md
193
README.md
|
|
@ -1,138 +1,137 @@
|
|||
# Dawarich
|
||||
|
||||
# 🌍 Dawarich: Your Self-Hosted Location History Tracker
|
||||
|
||||
[](https://discord.gg/pHsBjpt5J8) | [](https://ko-fi.com/H2H3IDYDD) | [](https://www.patreon.com/freika)
|
||||
Donate using crypto: [0x6bAd13667692632f1bF926cA9B421bEe7EaEB8D4](https://etherscan.io/address/0x6bAd13667692632f1bF926cA9B421bEe7EaEB8D4)
|
||||
|
||||
[](https://app.circleci.com/pipelines/github/Freika/dawarich)
|
||||
|
||||
## Screenshots
|
||||
---
|
||||
|
||||
## 📸 Screenshots
|
||||
|
||||
|
||||
*Map View*
|
||||
|
||||
|
||||
*Statistics Overview*
|
||||
|
||||
|
||||
*Imports page*
|
||||
|
||||
Dawarich is a self-hosted web application to replace Google Timeline (aka Google Location History). It allows you to import your location history from Google Maps Timeline and Owntracks, view it on a map and see some statistics, such as the number of countries and cities visited, and distance traveled.
|
||||
---
|
||||
|
||||
You can find changelog [here](CHANGELOG.md).
|
||||
## 🗺️ About Dawarich
|
||||
|
||||
## Disclaimer
|
||||
**Dawarich** is a self-hosted web app designed to replace Google Timeline (aka Google Location History). It enables you to:
|
||||
- Visualize your data on an interactive map.
|
||||
- Import your location history from Google Maps Timeline and Owntracks.
|
||||
- Explore statistics like the number of countries and cities visited, total distance traveled, and more!
|
||||
|
||||
⚠️ The project is under very active development.
|
||||
📄 **Changelog**: Find the latest updates [here](CHANGELOG.md).
|
||||
|
||||
⚠️ Expect bugs and breaking changes.
|
||||
---
|
||||
|
||||
⚠️ Do not delete your original Google Maps
|
||||
Timeline data after importing it to Dawarich.
|
||||
## ⚠️ Disclaimer
|
||||
|
||||
⚠️ Export your data from Dawarich using built-in
|
||||
export functionality before updating to a new version.
|
||||
- 🛠️ **Under active development**: Expect frequent updates, bugs, and breaking changes.
|
||||
- ❌ **Do not delete your original data** after importing into Dawarich.
|
||||
- 📦 **Backup before updates**: Always [backup your data](https://dawarich.app/docs/tutorials/backup-and-restore) before upgrading.
|
||||
- 🔄 **Stay up-to-date**: Make sure you're running the latest version for the best experience.
|
||||
|
||||
⚠️ Try to keep Dawarich up-to-date to have the latest features and bug fixes.
|
||||
---
|
||||
|
||||
## Usage
|
||||
## 🧭 Supported Location Tracking
|
||||
|
||||
Following sources of live data are supported:
|
||||
You can track your location with the following apps:
|
||||
|
||||
- [Overland](https://dawarich.app/docs/tutorials/track-your-location#overland)
|
||||
- [OwnTracks](https://dawarich.app/docs/tutorials/track-your-location#owntracks)
|
||||
- [GPSLogger](https://dawarich.app/docs/tutorials/track-your-location#gps-logger)
|
||||
- [Home Assistant](https://dawarich.app/docs/tutorials/track-your-location#homeassistant)
|
||||
- 🌍 [Overland](https://dawarich.app/docs/tutorials/track-your-location#overland)
|
||||
- 🛰️ [OwnTracks](https://dawarich.app/docs/tutorials/track-your-location#owntracks)
|
||||
- 🗺️ [GPSLogger](https://dawarich.app/docs/tutorials/track-your-location#gps-logger)
|
||||
- 🏡 [Home Assistant](https://dawarich.app/docs/tutorials/track-your-location#homeassistant)
|
||||
|
||||
To track your location, install the [Owntracks app](https://owntracks.org/booklet/guide/apps/) or [Overland app](https://overland.p3k.app/) on your phone and configure it to send location updates to your Dawarich instance.
|
||||
Simply install one of the supported apps on your device and configure it to send location updates to your Dawarich instance.
|
||||
|
||||
### OwnTracks
|
||||
---
|
||||
|
||||
The url to send the location updates to is `http://<your-dawarich-instance>/api/v1/owntracks/points?api_key=YOUR_API_KEY`.
|
||||
## 🚀 How to Start Dawarich Locally
|
||||
|
||||
Currently, the app only supports [HTTP mode](https://owntracks.org/booklet/tech/http/) of OwnTracks.
|
||||
1. Clone the repository.
|
||||
2. Run the following command to start the app:
|
||||
```bash
|
||||
docker-compose up
|
||||
```
|
||||
3. Access the app at `http://localhost:3000`.
|
||||
|
||||
### Overland
|
||||
⏹️ **To stop the app**, press `Ctrl+C`.
|
||||
|
||||
The url to send the location updates to is `http://<your-dawarich-instance>/api/v1/overland/batches?api_key=YOUR_API_KEY`.
|
||||
---
|
||||
|
||||
Your API key can be found and/or generated in the user settings.
|
||||
## 🔧 How to Install Dawarich
|
||||
|
||||
To import your Google Maps Timeline data, download your location history from [Google Takeout](https://takeout.google.com/) and upload it to Dawarich.
|
||||
|
||||
## How-to's
|
||||
|
||||
- [How to set up reverse proxy](docs/how_to_setup_reverse_proxy.md)
|
||||
- [How to import Google Takeout to Dawarich](https://dawarich.app/docs/tutorials/import-existing-data#sources-of-data)
|
||||
- [How to import Google Semantic History to Dawarich](https://dawarich.app/docs/tutorials/import-existing-data#semantic-location-history)
|
||||
- [How to import Google Maps Timeline Data to Dawarich](https://dawarich.app/docs/tutorials/import-existing-data#recordsjson)
|
||||
- [How to track your location to Dawarich with Overland](https://dawarich.app/docs/tutorials/track-your-location#overland)
|
||||
- [How to track your location to Dawarich with OwnTracks](https://dawarich.app/docs/tutorials/track-your-location#owntracks)
|
||||
- [How to export your data from Dawarich](https://dawarich.app/docs/tutorials/export-your-data)
|
||||
|
||||
More guides can be found in the [Docs](https://dawarich.app/docs/intro)
|
||||
|
||||
## Features
|
||||
|
||||
### Location Tracking
|
||||
|
||||
You can track your location using the Owntracks or Overland app.
|
||||
|
||||
### Location history
|
||||
|
||||
You can view your location history on a map. On the map you can enable/disable the following layers:
|
||||
|
||||
- Heatmap
|
||||
- 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
|
||||
|
||||
You can see the number of countries and cities visited, the distance traveled, and the time spent in each country, splitted by years and months.
|
||||
|
||||
### Import
|
||||
|
||||
You can import your existing location history from:
|
||||
|
||||
- Google Maps Timeline
|
||||
- OwnTracks
|
||||
- Strava
|
||||
- Immich
|
||||
- Your own GPX files
|
||||
- Your own GeoJSON files
|
||||
- Your photos' EXIF data
|
||||
|
||||
### Export
|
||||
|
||||
You can export your data to GeoJSON or GPX format.
|
||||
|
||||
## How to start the app locally
|
||||
|
||||
`docker-compose up` to start the app. The app will be available at `http://localhost:3000`.
|
||||
|
||||
Press `Ctrl+C` to stop the app.
|
||||
|
||||
## How to install the app
|
||||
|
||||
**[Docker](https://dawarich.app/docs/intro#setup-your-dawarich-instance)**
|
||||
|
||||
**[Synology](https://dawarich.app/docs/tutorials/platforms/synology)**
|
||||
|
||||
### Default credentials
|
||||
- **[Docker Setup](https://dawarich.app /docs/intro#setup-your-dawarich-instance)**
|
||||
- **[Synology](https://dawarich.app/docs/tutorials/platforms/synology)**
|
||||
|
||||
🆕 **Default Credentials**
|
||||
- **Username**: `user@domain.com`
|
||||
- **Password**: `password`
|
||||
(Feel free to change them in the account settings.)
|
||||
|
||||
Feel free to change them both in the Account section.
|
||||
---
|
||||
|
||||
## Environment variables
|
||||
## 📊 Features
|
||||
|
||||
See the docs on the [website](https://dawarich.app/docs/environment-variables-and-settings)
|
||||
### 🔍 Location Tracking
|
||||
- Track your live location using one of the [supported apps](#-supported-location-tracking).
|
||||
|
||||
## Star History
|
||||
### 🗺️ Location History Visualization
|
||||
- View your historical data on a map with customizable layers:
|
||||
- Heatmap
|
||||
- Points
|
||||
- Lines between points
|
||||
- Fog of War
|
||||
|
||||
### 🔵 Areas
|
||||
- Draw areas on the map so Dawarich could suggest your visits there.
|
||||
|
||||
### 📍 Visits (Beta)
|
||||
- Dawarich can suggest places you've visited and allow you to confirm or reject them.
|
||||
|
||||
### 📊 Statistics
|
||||
- Analyze your travel history: number of countries/cities visited, distance traveled, and time spent, broken down by year and month.
|
||||
|
||||
### 📥 Import Your Data
|
||||
- Import from various sources:
|
||||
- Google Maps Timeline
|
||||
- OwnTracks
|
||||
- Strava
|
||||
- Immich
|
||||
- GPX/GeoJSON files
|
||||
- Photos’ EXIF data
|
||||
|
||||
### 📤 Export Your Data
|
||||
- Export your data to GeoJSON or GPX formats.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Guides and Tutorials
|
||||
|
||||
- [Set up Reverse Proxy](https://dawarich.app/docs/tutorials/reverse-proxy)
|
||||
- [Import Google Takeout](https://dawarich.app/docs/tutorials/import-existing-data#sources-of-data)
|
||||
- [Track Location with Overland](https://dawarich.app/docs/tutorials/track-your-location#overland)
|
||||
- [Track Location with OwnTracks](https://dawarich.app/docs/tutorials/track-your-location#owntracks)
|
||||
- [Export Your Data](https://dawarich.app/docs/tutorials/export-your-data)
|
||||
|
||||
🛠️ More guides available in the [Docs](https://dawarich.app/docs/intro).
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Environment Variables
|
||||
|
||||
Check the documentation on the [website](https://dawarich.app/docs/environment-variables-and-settings) for detailed information about environment variables and settings.
|
||||
|
||||
---
|
||||
|
||||
## 💫 Star History
|
||||
|
||||
As you could probably guess, I like statistics.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue