docs: update docs and AGENTS.md with chat tool loop fix patterns
This commit is contained in:
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: architecture
|
||||
type: note
|
||||
permalink: voyage/docs/architecture
|
||||
---
|
||||
|
||||
# Voyage Architecture
|
||||
|
||||
> **Status**: Stub — to be expanded as architecture evolves.
|
||||
@@ -38,4 +44,4 @@ Session-based via `django-allauth`. CSRF tokens from `/auth/csrf/`, passed as `X
|
||||
- [ ] Data flow diagrams
|
||||
- [ ] Database schema overview
|
||||
- [ ] Deployment architecture
|
||||
- [ ] MCP endpoint architecture
|
||||
- [ ] MCP endpoint architecture
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: development_timeline
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/development-timeline
|
||||
---
|
||||
|
||||
# Voyage: Development Timeline & Origin Story
|
||||
|
||||
By: Sean Morley, Founder & Lead Developer
|
||||
@@ -206,4 +212,4 @@ Writing this made me realize how much of Voyage’s identity came from mistakes,
|
||||
|
||||
If you made it this far: thanks. If you want to help — issues, PRs, ideas, or design feedback are always welcome. The project is alive because of an amazing community of users and contributors!
|
||||
|
||||
— Sean
|
||||
— Sean
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-10-0
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/v0-10-0
|
||||
---
|
||||
|
||||
# Voyage v0.10.0 - Trip Maps, Google Maps Integration & Quick Deploy Script
|
||||
|
||||
Released 06-10-2025
|
||||
@@ -118,4 +124,4 @@ Thanks for being part of the Voyage community. I appreciate your feedback and lo
|
||||
|
||||
Happy travels,
|
||||
**Sean Morley** (@seanmorley15)
|
||||
Project Lead, Voyage
|
||||
Project Lead, Voyage
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-11-0
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/v0-11-0
|
||||
---
|
||||
|
||||
# Voyage v0.11.0 - Strava + Wanderer Integration, New UI, and More
|
||||
|
||||
Released 09-02-2025
|
||||
@@ -113,4 +119,4 @@ Thanks for being part of the Voyage community!
|
||||
|
||||
Happy travels,
|
||||
**Sean Morley** (@seanmorley15)
|
||||
Project Lead, Voyage
|
||||
Project Lead, Voyage
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-12-0
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/v0-12-0
|
||||
---
|
||||
|
||||
# Voyage v0.12.0 - Trip Planning Improvements, Itineraries & Budgets
|
||||
|
||||
Released 02-03-2026
|
||||
@@ -134,4 +140,4 @@ Happy planning & happy travels!
|
||||
|
||||
**Sean Morley** (@seanmorley15)
|
||||
|
||||
Founder & Project Lead
|
||||
Founder & Project Lead
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-7-0
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/v0-7-0
|
||||
---
|
||||
|
||||
# Voyage v0.7.0
|
||||
|
||||
Released 10-15-2024
|
||||
@@ -46,4 +52,4 @@ Hope you all enjoy!
|
||||
Feel free to join the release discussion below to share feedback and ideas or anything else related to this update!
|
||||
|
||||
Happy travels,
|
||||
Sean @seanmorley15
|
||||
Sean @seanmorley15
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-7-1
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/v0-7-1
|
||||
---
|
||||
|
||||
# Voyage v0.7.1
|
||||
|
||||
Released 11-13-2024
|
||||
@@ -55,4 +61,4 @@ Hope you all enjoy!
|
||||
Feel free to join the release discussion below to share feedback and ideas or anything else related to this update!
|
||||
|
||||
Happy travels,
|
||||
Sean @seanmorley15
|
||||
Sean @seanmorley15
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-8-0
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/v0-8-0
|
||||
---
|
||||
|
||||
# Voyage v0.8.0 - Immich Integration, Calendar and Customization
|
||||
|
||||
Released 01-08-2025
|
||||
@@ -101,4 +107,4 @@ Enjoy the update! 🎉
|
||||
Feel free to share your feedback, ideas, or questions in the discussion below or on the official [discord server](https://discord.gg/wRbQ9Egr8C)!
|
||||
|
||||
Happy travels,
|
||||
**Sean Morley** (@seanmorley15)
|
||||
**Sean Morley** (@seanmorley15)
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-9-0
|
||||
type: note
|
||||
permalink: voyage/docs/docs/changelogs/v0-9-0
|
||||
---
|
||||
|
||||
# Voyage v0.9.0 - Smart Recommendations, Attachments, and Maps
|
||||
|
||||
Released 03-19-2025
|
||||
@@ -129,4 +135,4 @@ Happy travels,
|
||||
|
||||
---
|
||||
|
||||
**[Full Changelog](https://github.com/Alex-Wiesner/voyage/compare/v0.8.0...v0.9.0)**
|
||||
**[Full Changelog](https://github.com/Alex-Wiesner/voyage/compare/v0.8.0...v0.9.0)**
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: advanced_configuration
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/advanced-configuration
|
||||
---
|
||||
|
||||
# Advanced Configuration
|
||||
|
||||
In addition to the primary configuration variables listed above, there are several optional environment variables that can be set to further customize your Voyage instance. These variables are not required for a basic setup but can enhance functionality and security.
|
||||
@@ -20,4 +26,4 @@ Voyage's MCP endpoint requires token authentication.
|
||||
- Override path with: `DJANGO_MCP_ENDPOINT`
|
||||
- Token bootstrap endpoint for authenticated sessions: `GET /auth/mcp-token/`
|
||||
|
||||
For MCP usage patterns and tool-level examples, see the [Travel Agent (MCP) guide](../guides/travel_agent.md).
|
||||
For MCP usage patterns and tool-level examples, see the [Travel Agent (MCP) guide](../guides/travel_agent.md).
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: analytics
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/analytics
|
||||
---
|
||||
|
||||
# Umami Analytics (optional)
|
||||
|
||||
Umami Analytics is a free, open-source, and privacy-focused web analytics tool that can be used as an alternative to Google Analytics. Learn more about Umami Analytics [here](https://umami.is/).
|
||||
@@ -7,4 +13,4 @@ To enable Umami Analytics for your Voyage instance, you can set the following va
|
||||
```yaml
|
||||
PUBLIC_UMAMI_SRC=https://cloud.umami.is/script.js # If you are using the hosted version of Umami
|
||||
PUBLIC_UMAMI_WEBSITE_ID=
|
||||
```
|
||||
```
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: disable_registration
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/disable-registration
|
||||
---
|
||||
|
||||
# Disable Registration
|
||||
|
||||
To disable registration, you can set the following variable in your docker-compose.yml under the server service:
|
||||
@@ -7,4 +13,4 @@ environment:
|
||||
- DISABLE_REGISTRATION=True
|
||||
# OPTIONAL: Set the message to display when registration is disabled
|
||||
- DISABLE_REGISTRATION_MESSAGE='Registration is disabled for this instance of Voyage.'
|
||||
```
|
||||
```
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: email
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/email
|
||||
---
|
||||
|
||||
# Change Email Backend
|
||||
|
||||
To change the email backend, you can set the following variable in your docker-compose.yml under the server service:
|
||||
@@ -31,4 +37,4 @@ By default, the email will display `[example.com]` in the subject. You can custo
|
||||
2. Click on `Sites`
|
||||
3. Click on first site, it will probably be `example.com`
|
||||
4. Change the `Domain name` and `Display name` to your desired values
|
||||
5. Click `Save`
|
||||
5. Click `Save`
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: google_maps_integration
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/google-maps-integration
|
||||
---
|
||||
|
||||
# Google Maps Integration
|
||||
|
||||
To enable Google Maps integration in Voyage, you'll need to create a Google Maps API key. This key allows Voyage to use Google Maps services such as geocoding and location search throughout the application.
|
||||
@@ -39,4 +45,4 @@ Set the API key in your environment file or configuration under the backend serv
|
||||
GOOGLE_MAPS_API_KEY=your_api_key_here
|
||||
```
|
||||
|
||||
Once this is set, Voyage will be able to utilize Google Maps services for geocoding and location searches instead of relying on the default OpenStreetMap services.
|
||||
Once this is set, Voyage will be able to utilize Google Maps services for geocoding and location searches instead of relying on the default OpenStreetMap services.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: immich_integration
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/immich-integration
|
||||
---
|
||||
|
||||
# Immich Integration
|
||||
|
||||
### What is Immich?
|
||||
@@ -26,4 +32,4 @@ To integrate Immich with Voyage, you need to have an Immich server running and a
|
||||
- Click `Enable Immich` to save the settings.
|
||||
3. Now, when you are adding images to an adventure, you will see an option to search for images in Immich or upload from an album.
|
||||
|
||||
Enjoy the privacy and control of managing your travel media with Immich and Voyage! 🎉
|
||||
Enjoy the privacy and control of managing your travel media with Immich and Voyage! 🎉
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: social_auth
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/social-auth
|
||||
---
|
||||
|
||||
# Social Authentication
|
||||
|
||||
Voyage support authentication via 3rd party services and self-hosted identity providers. Once these services are enabled, users can log in to Voyage using their accounts from these services and link existing Voyage accounts to these services for easier access.
|
||||
@@ -13,4 +19,4 @@ The steps for each service varies so please refer to the specific service's docu
|
||||
|
||||
## Linking Existing Accounts
|
||||
|
||||
If you already have an Voyage account and would like to link it to a 3rd party service, you can do so by logging in to Voyage and navigating to the `Account Settings` page. From there, scroll down to `Social and OIDC Authentication` and click the `Launch Account Connections` button. If identity providers have been enabled on your instance, you will see a list of available services to link to.
|
||||
If you already have an Voyage account and would like to link it to a 3rd party service, you can do so by logging in to Voyage and navigating to the `Account Settings` page. From there, scroll down to `Social and OIDC Authentication` and click the `Launch Account Connections` button. If identity providers have been enabled on your instance, you will see a list of available services to link to.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: authentik
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/social-auth/authentik
|
||||
---
|
||||
|
||||
# Authentik OIDC Authentication
|
||||
|
||||
<img src="https://repository-images.githubusercontent.com/230885748/19f01d00-8e26-11eb-9a14-cf0d28a1b68d" alt="Authentik Logo" width="400" />
|
||||
@@ -67,4 +73,4 @@ Ensure the `<voyage-server-url>/accounts` path is routed to the backend, as it s
|
||||
|
||||
### Authentik - No Permission
|
||||
|
||||
In the Authentik instance, check access to the Voyage application from a specific user by using the Check Access/Test button on the Application dashboard. If the user doesn't have access, you can add an existing user/group policy to give your specific user/group access to the Voyage application.
|
||||
In the Authentik instance, check access to the Voyage application from a specific user by using the Check Access/Test button on the Application dashboard. If the user doesn't have access, you can add an existing user/group policy to give your specific user/group access to the Voyage application.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: github
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/social-auth/github
|
||||
---
|
||||
|
||||
# GitHub Social Authentication
|
||||
|
||||
Voyage can be configured to use GitHub as an identity provider for social authentication. Users can then log in to Voyage using their GitHub account.
|
||||
@@ -45,5 +51,4 @@ If a user has an existing Voyage account and wants to link it to their Github ac
|
||||
|
||||
#### What it Should Look Like
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
---
|
||||
title: oidc
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/social-auth/oidc
|
||||
---
|
||||
|
||||
# OIDC Social Authentication
|
||||
|
||||
Voyage can be configured to use OpenID Connect (OIDC) as an identity provider for social authentication. Users can then log in to Voyage using their OIDC account.
|
||||
|
||||
The configuration is basically the same as [Authentik](./authentik.md), but you replace the client and secret with the OIDC client and secret provided by your OIDC provider. The `server_url` should be the URL of your OIDC provider where you can find the OIDC configuration.
|
||||
|
||||
Each provider has a different configuration, so you will need to check the documentation of your OIDC provider to find the correct configuration.
|
||||
Each provider has a different configuration, so you will need to check the documentation of your OIDC provider to find the correct configuration.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: pocket_id
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/social-auth/pocket-id
|
||||
---
|
||||
|
||||
# Pocket ID OIDC Authentication
|
||||
|
||||
<img src="https://pocket-id.org/logo.png" alt="Pocket ID Logo" width="400" />
|
||||
@@ -140,4 +146,4 @@ in a browser.
|
||||
|
||||
- Pocket ID configuration is very similar to Authentik.
|
||||
- The main difference is the **explicit callback URL requirement** and the use of the `.well-known/openid-configuration` endpoint as the `server_url`.
|
||||
- This setup works with Docker, Docker Compose, and bare-metal deployments as long as networking i
|
||||
- This setup works with Docker, Docker Compose, and bare-metal deployments as long as networking i
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: strava_integration
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/strava-integration
|
||||
---
|
||||
|
||||
# Strava Integration
|
||||
|
||||
Strava is a popular platform for athletes to track their activities, share their workouts, and connect with other fitness enthusiasts. Integrating Strava with Voyage allows you to import your Strava activities directly into your vists, making it easier to keep track of your outdoor experiences.
|
||||
@@ -40,4 +46,4 @@ The Strava integration appears on the visit create/edit part of the location edi
|
||||
|
||||
**Note**: Due to API limitations on Strava's side, when you import an activity, there will be a button that says **Download GPX** then you can download the GPX file of the activity and drop it into the input field of the visit. This manual action is necessary because Strava does not provide a direct way to import GPX files into Voyage.
|
||||
|
||||
Enjoy tracking your adventures with Strava and Voyage! If you encounter any issues or have questions about the integration, feel free to reach out to the Voyage community!
|
||||
Enjoy tracking your adventures with Strava and Voyage! If you encounter any issues or have questions about the integration, feel free to reach out to the Voyage community!
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: updating
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/updating
|
||||
---
|
||||
|
||||
# Updating
|
||||
|
||||
Updating Voyage when using docker can be quite easy. Run a collections backup before upgrading, then pull the latest version and restart the containers.
|
||||
@@ -40,4 +46,4 @@ Once you are in the container run the following command to resync the region dat
|
||||
|
||||
```bash
|
||||
python manage.py download-countries --force
|
||||
```
|
||||
```
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: wanderer_integration
|
||||
type: note
|
||||
permalink: voyage/docs/docs/configuration/wanderer-integration
|
||||
---
|
||||
|
||||
# Wanderer Integration
|
||||
|
||||
[Wanderer](https://wanderer.to) is a self-hosted trail database. Integrating Wanderer with Voyage allows you to import trails directly into your locations, making it easier to plan and track your outdoor adventures.
|
||||
@@ -23,4 +29,4 @@
|
||||
5. Select the desired trail from the search results and click the link icon to import it into your location.
|
||||
6. The imported trail will be added to your location's trails list, and you can view its details, including distance, elevation gain, and more.
|
||||
|
||||
Enjoy exploring new trails with Wanderer and Voyage! If you encounter any issues or have questions about the integration, feel free to reach out to the Voyage community!
|
||||
Enjoy exploring new trails with Wanderer and Voyage! If you encounter any issues or have questions about the integration, feel free to reach out to the Voyage community!
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: admin_panel
|
||||
type: note
|
||||
permalink: voyage/docs/docs/guides/admin-panel
|
||||
---
|
||||
|
||||
# Voyage Admin Panel
|
||||
|
||||
The Voyage Admin Panel, powered by Django, is a web-based interface that allows administrators to manage objects in the Voyage database. The Admin Panel is accessible at the `/admin` endpoint of the Voyage server. Example: `https://al-server.yourdomain.com/admin`.
|
||||
@@ -8,4 +14,4 @@ Features of the Admin Panel include:
|
||||
- **Adventure Management**: Administrators can view and manage adventures, including creating new adventures, updating adventure information, and deleting adventures.
|
||||
- **Security**: The Admin Panel enforces access control to ensure that only authorized administrators can access and manage the database. This means that only users with the `is_staff` flag set to `True` can access the Admin Panel.
|
||||
|
||||
Note: the `CSRF_TRUSTED_ORIGINS` setting in your `docker-compose.yml` file must include the domain of the server. For example, if your server is hosted at `https://al-server.yourdomain.com`, you should add `al-server.yourdomain.com` to the `CSRF_TRUSTED_ORIGINS` setting.
|
||||
Note: the `CSRF_TRUSTED_ORIGINS` setting in your `docker-compose.yml` file must include the domain of the server. For example, if your server is hosted at `https://al-server.yourdomain.com`, you should add `al-server.yourdomain.com` to the `CSRF_TRUSTED_ORIGINS` setting.
|
||||
@@ -1,6 +1,12 @@
|
||||
---
|
||||
title: invite_user
|
||||
type: note
|
||||
permalink: voyage/docs/docs/guides/invite-user
|
||||
---
|
||||
|
||||
# Invite a User
|
||||
|
||||
Voyage allows for admin users to invite new users to create an account via an email invitation.
|
||||
Invites are sent from the Voyage [Admin Panel](admin_panel.md) or via a custom invite form. The invite section of the admin panel can be found at `/admin/invitations/invitation/add/`.
|
||||
|
||||
Tip: make sure you have a working email setup for Voyage to send emails. See the [Email Configuration Guide](../configuration/email.md) for more information.
|
||||
Tip: make sure you have a working email setup for Voyage to send emails. See the [Email Configuration Guide](../configuration/email.md) for more information.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: travel_agent
|
||||
type: note
|
||||
permalink: voyage/docs/docs/guides/travel-agent
|
||||
---
|
||||
|
||||
# Travel Agent (MCP)
|
||||
|
||||
Voyage includes a **Travel Agent** interface exposed through an **MCP-compatible HTTP endpoint**. This lets external MCP clients read and manage trip itineraries programmatically for authenticated users.
|
||||
@@ -154,4 +160,4 @@ Server -> [...updated itinerary items...]
|
||||
## Related docs
|
||||
|
||||
- [Advanced Configuration](../configuration/advanced_configuration.md)
|
||||
- [How to use Voyage](../usage/usage.md)
|
||||
- [How to use Voyage](../usage/usage.md)
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: v0-7-1_migration
|
||||
type: note
|
||||
permalink: voyage/docs/docs/guides/v0-7-1-migration
|
||||
---
|
||||
|
||||
# Voyage v0.7.1 Migration
|
||||
|
||||
In order to make installation easier, the Voyage v0.7.1 release has **removed the need for a separate nginx container** and config to serve the media files. Instead, the media files are now served by an instance of nginx running in the same container as the Django application.
|
||||
@@ -34,4 +40,4 @@ Enjoy the new version of Voyage! 🎉
|
||||
|
||||
View the full changelog [here](https://github.com/Alex-Wiesner/voyage/releases/tag/v0.7.1)
|
||||
|
||||
Report any bugs [GitHub repository](https://github.com/Alex-Wiesner/voyage) or ask for help in the [Discord server](https://discord.gg/wRbQ9Egr8C).
|
||||
Report any bugs [GitHub repository](https://github.com/Alex-Wiesner/voyage) or ask for help in the [Discord server](https://discord.gg/wRbQ9Egr8C).
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: caddy
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/caddy
|
||||
---
|
||||
|
||||
# Installation with Caddy
|
||||
|
||||
Caddy is a modern HTTP reverse proxy. It automatically integrates with Let's Encrypt (or other certificate providers) to generate TLS certificates for your site.
|
||||
@@ -64,4 +70,4 @@ Once configured, you can start up the containsers:
|
||||
docker compose up
|
||||
```
|
||||
|
||||
Your Voyage should now be up and running.
|
||||
Your Voyage should now be up and running.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: dev_container_wsl
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/dev-container-wsl
|
||||
---
|
||||
|
||||
# Dev Container + WSL 🧰
|
||||
|
||||
Running Voyage in a **Dev Container** allows you to contribute to the project or work on features locally in a fully reproducible development environment with hot reloading, debugging, and tooling isolated inside Docker.
|
||||
@@ -177,4 +183,4 @@ For production or personal hosting, follow the standard
|
||||
[**Docker 🐋 installation guide**](docker.md).
|
||||
|
||||
Enjoy contributing to Voyage! 🎉
|
||||
If you run into issues not covered here, please open a discussion or issue so the docs can be improved.
|
||||
If you run into issues not covered here, please open a discussion or issue so the docs can be improved.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: docker
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/docker
|
||||
---
|
||||
|
||||
# Docker 🐋
|
||||
|
||||
Docker is the preferred way to run Voyage on your local machine. It is a lightweight containerization technology that allows you to run applications in isolated environments called containers.
|
||||
@@ -89,4 +95,4 @@ docker compose -f docker-compose.dev.yml run --rm --no-deps --build web sh -lc "
|
||||
|
||||
This runs the Svelte type check fully inside Docker (no host Node/bun required).
|
||||
|
||||
Enjoy using Voyage! 🎉
|
||||
Enjoy using Voyage! 🎉
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: getting_started
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/getting-started
|
||||
---
|
||||
|
||||
# 🚀 Install Options for Voyage
|
||||
|
||||
Voyage can be installed in a variety of ways, depending on your platform or preference.
|
||||
@@ -25,4 +31,4 @@ Perfect for Docker beginners.
|
||||
- [Nginx Proxy Manager](nginx_proxy_manager.md) - Easy reverse proxy config
|
||||
- [Traefik](traefik.md) — Dynamic reverse proxy with automation
|
||||
- [Caddy](caddy.md) — Automatic HTTPS with a clean config
|
||||
- [Dev Container + WSL](dev_container_wsl.md) - Windows dev environment with WSL 2 + Dev Containers
|
||||
- [Dev Container + WSL](dev_container_wsl.md) - Windows dev environment with WSL 2 + Dev Containers
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: kustomize
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/kustomize
|
||||
---
|
||||
|
||||
# Kubernetes and Kustomize (k8s)
|
||||
|
||||
_Voyage can be run inside a kubernetes cluster using [kustomize](https://kustomize.io/)._
|
||||
@@ -31,4 +37,4 @@ Take a look at the [example config](https://github.com/Alex-Wiesner/voyage/blob/
|
||||
|
||||
Look at the [environment variable summary](docker.md#configuration) in the docker install section to see available and required configuration options.
|
||||
|
||||
Enjoy Voyage! 🎉
|
||||
Enjoy Voyage! 🎉
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: nginx_proxy_manager
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/nginx-proxy-manager
|
||||
---
|
||||
|
||||
# Installation with Nginx Proxy Manager
|
||||
|
||||
Nginx Proxy Manager is a simple and powerful tool that allows you to manage Nginx proxy hosts and SSL certificates. It is designed to be easy to use and configure, and it integrates well with Docker.
|
||||
@@ -45,4 +51,4 @@ networks:
|
||||
- **Forward Hostname/IP**: `voyage-backend` The name of the Voyage **backend** container in the `docker-compose.yml` file.
|
||||
- **Forward Port**: `80` This is the internal port of the Voyage **backend** container so you will not need to change it even if you change the external port.
|
||||
|
||||
This will allow you to access Voyage using the domain name you specified in the Nginx Proxy Manager configuration.
|
||||
This will allow you to access Voyage using the domain name you specified in the Nginx Proxy Manager configuration.
|
||||
@@ -1,4 +1,10 @@
|
||||
---
|
||||
title: proxmox_lxc
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/proxmox-lxc
|
||||
---
|
||||
|
||||
# Proxmox LXC 🐧
|
||||
|
||||
Voyage can be installed in a Proxmox LXC container. This script created by the community will help you install Voyage in a Proxmox LXC container.
|
||||
[Proxmox VE Helper-Scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=voyage)
|
||||
[Proxmox VE Helper-Scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=voyage)
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: quick_start
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/quick-start
|
||||
---
|
||||
|
||||
# 🚀 Quick Start Install
|
||||
|
||||
Install **Voyage** in seconds using our automated script.
|
||||
@@ -42,4 +48,4 @@ docker compose down -v
|
||||
rm -rf voyage
|
||||
```
|
||||
|
||||
Need more control? Explore other [install options](getting_started.md) like Docker, Proxmox, Synology NAS, and more.
|
||||
Need more control? Explore other [install options](getting_started.md) like Docker, Proxmox, Synology NAS, and more.
|
||||
@@ -1,7 +1,13 @@
|
||||
---
|
||||
title: synology_nas
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/synology-nas
|
||||
---
|
||||
|
||||
# Installation on a Synology NAS
|
||||
|
||||
Voyage can be deployed on a Synology NAS using Docker. This guide from Marius Hosting will walk you through the process.
|
||||
|
||||
[Read the guide Here](https://mariushosting.com/how-to-install-voyage-on-your-synology-nas/)
|
||||
|
||||
In recent versions of Synology DSM, there might be some adjustments needed to fix Nginx should a 502 Bad Gateway Error be returned. That guide can be found [here](https://mariushosting.com/synology-nginx-reverse-proxy-how-to-fix-502-bad-gateway-error/).
|
||||
In recent versions of Synology DSM, there might be some adjustments needed to fix Nginx should a 502 Bad Gateway Error be returned. That guide can be found [here](https://mariushosting.com/synology-nginx-reverse-proxy-how-to-fix-502-bad-gateway-error/).
|
||||
@@ -1,7 +1,13 @@
|
||||
---
|
||||
title: traefik
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/traefik
|
||||
---
|
||||
|
||||
# Installation with Traefik
|
||||
|
||||
Traefik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy. It is designed to be simple to use and configure, and it integrates well with Docker.
|
||||
|
||||
Voyage has a built-in Traefik configuration that makes it easy to deploy and manage your Voyage instance.
|
||||
|
||||
The most recent version of the Traefik `docker-compose.yml` file can be found in the [Voyage GitHub repository](https://github.com/Alex-Wiesner/voyage/blob/main/docker-compose-traefik.yaml).
|
||||
The most recent version of the Traefik `docker-compose.yml` file can be found in the [Voyage GitHub repository](https://github.com/Alex-Wiesner/voyage/blob/main/docker-compose-traefik.yaml).
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: unraid
|
||||
type: note
|
||||
permalink: voyage/docs/docs/install/unraid
|
||||
---
|
||||
|
||||
# Installation with Unraid
|
||||
|
||||
Voyage is available in the Unraid Community Applications store. You can install it by searching for `Voyage` in the Community Applications store, where you will find the frontend and the backend. The database can be found by searching `PostGIS`.
|
||||
@@ -74,4 +80,4 @@ docker network create example
|
||||
|
||||
Youtuber AlienTech42 has created a helpful video walking through the installation of Voyage on Unraid:
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/hJnoePdAhXg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/hJnoePdAhXg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: voyage_overview
|
||||
type: note
|
||||
permalink: voyage/docs/docs/intro/voyage-overview
|
||||
---
|
||||
|
||||
# About Voyage
|
||||
|
||||
> **Voyage is a fork of [AdventureLog](https://github.com/seanmorley15/AdventureLog)**, the open-source travel companion created by [Sean Morley](https://seanmorley.com). Voyage builds on AdventureLog's foundation to make additional changes and improvements.
|
||||
@@ -36,4 +42,4 @@ Voyage is open-source software, licensed under the GPL-3.0 license. This means t
|
||||
|
||||
## Upstream Project
|
||||
|
||||
Voyage is a fork of [AdventureLog](https://github.com/seanmorley15/AdventureLog), created by [Sean Morley](https://seanmorley.com). Credit and thanks go to Sean and all contributors to the original project for building the foundation that Voyage is built upon.
|
||||
Voyage is a fork of [AdventureLog](https://github.com/seanmorley15/AdventureLog), created by [Sean Morley](https://seanmorley.com). Credit and thanks go to Sean and all contributors to the original project for building the foundation that Voyage is built upon.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: login_unresponsive
|
||||
type: note
|
||||
permalink: voyage/docs/docs/troubleshooting/login-unresponsive
|
||||
---
|
||||
|
||||
# Troubleshooting: Login and Registration Unresponsive
|
||||
|
||||
When you encounter issues with the login and registration pages being unresponsive in Voyage, it can be due to various reasons. This guide will help you troubleshoot and resolve the unresponsive login and registration pages in Voyage.
|
||||
@@ -15,4 +21,4 @@ When you encounter issues with the login and registration pages being unresponsi
|
||||
- Check that the `ORIGIN` variable in the frontend is set to the URL where the frontend is access and you are accessing the app from currently.
|
||||
- Check that the `CSRF_TRUSTED_ORIGINS` variable in the backend is set to a comma separated list of the origins where you use your backend server and frontend. One of these values should match the `ORIGIN` variable in the frontend.
|
||||
|
||||
4. If you are still experiencing issues, please refer to the [Voyage Discord Server](https://discord.gg/wRbQ9Egr8C) for further assistance, providing as much detail as possible about the issue you are experiencing!
|
||||
4. If you are still experiencing issues, please refer to the [Voyage Discord Server](https://discord.gg/wRbQ9Egr8C) for further assistance, providing as much detail as possible about the issue you are experiencing!
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: nginx_failed
|
||||
type: note
|
||||
permalink: voyage/docs/docs/troubleshooting/nginx-failed
|
||||
---
|
||||
|
||||
# Troubleshooting: `Starting nginx: nginx failed!` in the Backend Container
|
||||
|
||||
::: tip
|
||||
@@ -42,4 +48,4 @@ If you're experiencing issues with the Nginx service failing to start in the bac
|
||||
|
||||
### 3. **Restart the Backend Container**:
|
||||
|
||||
These steps should help you resolve the issue with the Nginx service failing to start in the backend container. If you continue to face issues, please reach out to the Voyage community on Discord or GitHub for further assistance.
|
||||
These steps should help you resolve the issue with the Nginx service failing to start in the backend container. If you continue to face issues, please reach out to the Voyage community on Discord or GitHub for further assistance.
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: no_images
|
||||
type: note
|
||||
permalink: voyage/docs/docs/troubleshooting/no-images
|
||||
---
|
||||
|
||||
# Troubleshooting: Images Not Displayed in Voyage
|
||||
|
||||
The Voyage backend container uses a built-in Nginx container to serve media to the frontend. The `PUBLIC_URL` environment variable is set to the external URL of the **backend** container. This URL is used to generate the URLs for the images in the frontend. If this URL is not set correctly or not accessible from the frontend, the images will not be displayed.
|
||||
@@ -17,4 +23,4 @@ If you're experiencing issues with images not displaying in Voyage, follow these
|
||||
- For example:
|
||||
```
|
||||
CSRF_TRUSTED_ORIGINS=http://frontend.example.com,http://backend.example.com
|
||||
```
|
||||
```
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
title: usage
|
||||
type: note
|
||||
permalink: voyage/docs/docs/usage/usage
|
||||
---
|
||||
|
||||
# How to use Voyage
|
||||
|
||||
Welcome to Voyage! This guide will help you get started with Voyage and provide you with an overview of the features available to you.
|
||||
@@ -49,4 +55,4 @@ Provider errors (authentication, model not found, rate limits, invalid tool call
|
||||
|
||||
## Tutorial Video
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/4Y2LvxG3xn4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/4Y2LvxG3xn4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
@@ -1,35 +1,36 @@
|
||||
---
|
||||
# https://vitepress.dev/reference/default-theme-home-page
|
||||
layout: home
|
||||
|
||||
hero:
|
||||
name: "Voyage"
|
||||
text: "The ultimate travel companion."
|
||||
tagline: Discover new places, track your adventures, and share your experiences with friends and family.
|
||||
name: Voyage
|
||||
text: The ultimate travel companion.
|
||||
tagline: Discover new places, track your adventures, and share your experiences
|
||||
with friends and family.
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Get Started
|
||||
link: /docs/install/getting_started
|
||||
- theme: alt
|
||||
text: About
|
||||
link: /docs/intro/voyage_overview
|
||||
- theme: alt
|
||||
text: Demo
|
||||
link: https://demo.voyage.app
|
||||
- theme: brand
|
||||
text: Get Started
|
||||
link: /docs/install/getting_started
|
||||
- theme: alt
|
||||
text: About
|
||||
link: /docs/intro/voyage_overview
|
||||
- theme: alt
|
||||
text: Demo
|
||||
link: https://demo.voyage.app
|
||||
image:
|
||||
src: ./voyage.svg
|
||||
alt: Voyage Map Logo
|
||||
|
||||
features:
|
||||
- title: "Track Your Adventures"
|
||||
details: "Log your adventures and keep track of where you've been on the world map."
|
||||
icon: 📍
|
||||
- title: "Plan Your Next Trip"
|
||||
details: "Take the guesswork out of planning your next adventure with an easy-to-use itinerary planner."
|
||||
icon: 📅
|
||||
- title: "Share Your Experiences"
|
||||
details: "Share your adventures with friends and family and collaborate on trips together."
|
||||
icon: 📸
|
||||
- title: Track Your Adventures
|
||||
details: Log your adventures and keep track of where you've been on the world map.
|
||||
icon: 📍
|
||||
- title: Plan Your Next Trip
|
||||
details: Take the guesswork out of planning your next adventure with an easy-to-use
|
||||
itinerary planner.
|
||||
icon: 📅
|
||||
- title: Share Your Experiences
|
||||
details: Share your adventures with friends and family and collaborate on trips
|
||||
together.
|
||||
icon: 📸
|
||||
permalink: voyage/docs/index
|
||||
---
|
||||
|
||||
## ⚡️ Quick Start
|
||||
@@ -302,4 +303,4 @@ Stop letting amazing adventures fade from memory. Start documenting, planning, a
|
||||
details img {
|
||||
border-radius: 12px;
|
||||
}
|
||||
</style>
|
||||
</style>
|
||||
Reference in New Issue
Block a user