Wayfarer

Wayfarer Documentation

Wayfarer is a self-hosted travel companion for private location history, trip planning and optional live sharing. Choose the path that fits what you want to do.

Users

For using an existing Wayfarer instance, including one run by someone else. Start with the User Guide for accounts, privacy and your first actions.

• Timeline and locations: browse, correct and share your history.
• Trips: plan journeys, routes and visits.
• Groups: share locations with trusted people.
• Import and export: move history and Trip plans, including safe Mobile recovery.
• WayfarerMobile: connect your phone, record locations and use downloaded Trips.
• Personal location providers: optional addresses, search and routing with privacy and cost controls.

Self-hosters

For installing and operating your own instance, start with the Self-hosting guide.

• Hardware and history performance: measured workloads, host planning, protective limits and upgrade requirements.
• Operations: status, lifecycle, logs, account recovery, backup, update and restore.
• Troubleshooting: symptom-first safe checks and recovery paths.
• wayfarerctl reference: exact commands and refusal/recovery semantics.
• Native/manual deployment: advanced systemd/Nginx/source deployments.

Developers & Contributors

For local development, architecture, configuration, services, APIs, database work, testing and contributing. The Developer Guide explains where to start and how the frontend and backend fit together.

Project Maintainers

For people maintaining Wayfarer itself: release/version/publication ownership, lifecycle qualification, container/Compose internals, exceptional recovery authority and platform qualification. Ordinary self-hosting and operation follow the Self-hosters path above.

Start with the Project Maintainer guide, then use the specialist references for Versioning, Release contract, Application container, Publication and Production Compose.

Wayfarer is MIT-licensed and provided as is, without warranty.