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.

ℹ️ Pre-requisites:

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

1. Copy the docker-compose.yml file in the root of this repository to a directory:

   mkdir wayfinder && cd wayfinder

   curl -O https://raw.githubusercontent.com/dontic/wayfinder/main/docker-compose.yml

2. Modify the environment variables of the backend service as needed:

   nano docker-compose.yml

3. Run it!

   docker compose up -d

4. Access the app at localhost:8080

   You can modify this port in docker-compose.yml under the fronted service.

By default you will log in with user and password admin:admin.

Then go to your user (bottom left) -> settings:

1. Copy the Overland token (you can regenerate it when needed)

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

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.

docker compose pull && docker compose up -d

ℹ️ ALWAYS read the release notes!

There are sometimes where breaking changes are introduced

In these cases, usually there is some kind of actions needed that will be specified in the release notes.

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

With either VSCode or Cursor:

1. Open the /backend and /frontend directories in separate windows

2. Make sure you have the dev containers extension installed

3. In each window: F1 -> Dev Containers: Reopen in container

4. Read the README.md on both the frontend and the backend to see how to configure and start them.