Skip to content

dontic/wayfinder

Repository files navigation

License: MIT Latest version

Wayfinder is a self-hosted web app for Overland-iOS.


Wayfinder has 3 main components:

  1. A TimescaleDB database to store the location data received by Overland and other relevant data to make the App work
  2. A django REST backend to process incoming and outgoing datta.
  3. A desktop and mobile friendly React client to visualize the location data.

Get Started

Pre-requisites

You will need:

  • Basic Docker knowledge
  • A custom domain or dyndns service
  • A reverse proxy (nginx, Traefic...)

Docker compose and config file

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

2. Modify the config file as needed:

nano config.env
3. Spin the containers!
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.

Configuration

By default you will log in with user and password admin:admin, unless you uave modified it in config.env.

Then go to settings:

  1. Copy the Overland token (you can regenerate it once in a while to increase security)

  2. Paste the Token 'as is' into the Overland App token field

  3. Modify the Overland server url to <BASE_URL>/api/wayfinder/overland/

  4. Back in Wayfinder settings modify your username and password if needed

Overland settings

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.

Contributing

Feel free to open issues, feature requests or pull requests to enhance Wayfinder!