Wayfinder is a self-hosted web app for Overland-iOS.
Wayfinder has 3 main components:
- A TimescaleDB database to store the location data received by Overland and other relevant data to make the App work
- A django REST backend to process incoming and outgoing datta.
- A desktop and mobile friendly React client to visualize the location data.
You will need:
- Basic Docker knowledge
- A custom domain or dyndns service
- A reverse proxy (nginx, Traefic...)
1. Just copy the docker-compose.yml
and the config.env
files in the root of this repository to a directory (you can also copy these files manually):
mkdir wayfinder && cd wayfinder
curl -O https://raw.githubusercontent.com/dontic/wayfinder/main/docker-compose.yml
curl -O https://raw.githubusercontent.com/dontic/wayfinder/main/config.env
nano config.env
docker compose up -d
The web app should be accessible from localhost:8080
You can modify this port in the docker compose file under the fronted
service.
By default you will log in with user and password admin:admin
, unless you uave modified it in config.env
.
Then go to settings:
-
Copy the Overland token (you can regenerate it once in a while to increase security)
-
Paste the Token 'as is' into the Overland App token field
-
Modify the Overland server url to
<BASE_URL>/api/wayfinder/overland/
-
Back in Wayfinder settings modify your username and password if needed
These are the settings that work best with Wayfinder:
Note that only Wayfinder relevant settings are included. The rest are left to your choosing.
- Tracking Enabled:
On
- Continuous Tracking Mode:
Both
- Visit Tracking:
On
-> Necessary to log visits in Wayfinder - Loggin Mode:
All Data
- Locations per Batch: Depends on where you host Wayfinder. Bigger servers will handle bigger batches easier. I.e.: If you host on a raspberri pi keep it low to 50 or 100 per batch.
Feel free to open issues, feature requests or pull requests to enhance Wayfinder!