docs: update docs and AGENTS.md with chat tool loop fix patterns

This commit is contained in:
2026-03-10 18:40:29 +00:00
parent 0ca73a417d
commit c4b8f291f2
53 changed files with 801 additions and 73 deletions

View File

@@ -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).

View File

@@ -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=
```
```

View File

@@ -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.'
```
```

View File

@@ -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`

View File

@@ -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.

View File

@@ -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! 🎉

View File

@@ -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.

View File

@@ -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.

View File

@@ -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
![Authentik Social Auth Configuration](/github_settings.png)
![Authentik Social Auth Configuration](/github_settings.png)

View File

@@ -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.

View File

@@ -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

View File

@@ -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!

View File

@@ -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
```
```

View File

@@ -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!