mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2025-08-08 06:35:19 +02:00
feat: add Strava and Wanderer integration documentation and configuration options
This commit is contained in:
parent
41db74ea3a
commit
78341f86af
4 changed files with 82 additions and 0 deletions
|
@ -41,6 +41,11 @@ DISABLE_REGISTRATION=False
|
|||
# EMAIL_HOST_PASSWORD=password
|
||||
# DEFAULT_FROM_EMAIL=user@example.com
|
||||
|
||||
# Optional: Use Strava integration
|
||||
# https://adventurelog.app/docs/configuration/strava_integration.html
|
||||
# STRAVA_CLIENT_ID=your_strava_client_id
|
||||
# STRAVA_CLIENT_SECRET=your_strava_client_secret
|
||||
|
||||
# Optional: Use Umami for analytics
|
||||
# https://adventurelog.app/docs/configuration/analytics.html
|
||||
# PUBLIC_UMAMI_SRC=https://cloud.umami.is/script.js # If you are using the hosted version of Umami
|
||||
|
|
|
@ -175,6 +175,14 @@ export default defineConfig({
|
|||
text: "Google Maps Integration",
|
||||
link: "/docs/configuration/google_maps_integration",
|
||||
},
|
||||
{
|
||||
text: "Strava Integration",
|
||||
link: "/docs/configuration/strava_integration",
|
||||
},
|
||||
{
|
||||
text: "Wanderer Integration",
|
||||
link: "/docs/configuration/wanderer_integration",
|
||||
},
|
||||
{
|
||||
text: "Social Auth and OIDC",
|
||||
link: "/docs/configuration/social_auth",
|
||||
|
|
43
documentation/docs/configuration/strava_integration.md
Normal file
43
documentation/docs/configuration/strava_integration.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
# 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 AdventureLog allows you to import your Strava activities directly into your vists, making it easier to keep track of your outdoor experiences.
|
||||
|
||||
To enable Strava integration in AdventureLog, you'll need to create a Strava API application. This application will provide you with the necessary client ID and client secret to authenticate with the Strava API.
|
||||
|
||||
Follow the steps below to generate your own Strava API credentials:
|
||||
|
||||
## Strava API Application Setup
|
||||
|
||||
1. Login to your Strava account at [Strava](https://www.strava.com/).
|
||||
2. Go to the [Strava API Applications page](https://www.strava.com/settings/api).
|
||||
3. Click on **Create a New Application**.
|
||||
4. Fill in the application details:
|
||||
- **Application Name**: AdventureLog Strava Integration
|
||||
- **Website**: Your AdventureLog instance URL (e.g., `https://your-adventurelog-instance.com`)
|
||||
- **Authorization Callback Domain**: Your AdventureLog instance domain (e.g., `your-adventurelog-instance.com`)
|
||||
5. Agree to the Strava API Terms
|
||||
6. Click **Create** to generate your application.
|
||||
7. After creation, you will see your **Client ID** and **Client Secret**. Keep these credentials safe as you will need them to configure AdventureLog.
|
||||
|
||||
## Configuration in AdventureLog
|
||||
|
||||
8. Once you have your Strava API credentials, you can configure AdventureLog to use them. Open your `.env` file in the root of your AdventureLog project and add the following lines:
|
||||
|
||||
```env
|
||||
STRAVA_CLIENT_ID=your_client_id_here
|
||||
STRAVA_CLIENT_SECRET=your_client_secret_here
|
||||
```
|
||||
|
||||
9. After adding these lines, save the file and restart your AdventureLog server to apply the changes.
|
||||
10. Navigate to AdventureLog's settings page, click the integration tab, and find the Strava section.
|
||||
11. Click the **Connect Account** button. This will redirect you to Strava's authorization page.
|
||||
12. Log in to your Strava account and authorize AdventureLog to access your Strava data.
|
||||
13. After authorization, you will be redirected back to AdventureLog, and your Strava account will be linked.
|
||||
|
||||
## Importing Strava Activities
|
||||
|
||||
The Strava integration appears on the visit create/edit part of the location edit popup. Once a visit is added, there will be a button on it to search for Strava activities. Clicking this button will search then you can import the activity into the visit. The imported activity will include details such as distance, duration, elevation gain, and more.
|
||||
|
||||
**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 AdventureLog.
|
||||
|
||||
Enjoy tracking your adventures with Strava and AdventureLog! If you encounter any issues or have questions about the integration, feel free to reach out to the AdventureLog community!
|
26
documentation/docs/configuration/wanderer_integration.md
Normal file
26
documentation/docs/configuration/wanderer_integration.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
# Wanderer Integration
|
||||
|
||||
[Wanderer](https://wanderer.to) is a self-hosted trail database. Integrating Wanderer with AdventureLog allows you to import trails directly into your locations, making it easier to plan and track your outdoor adventures.
|
||||
|
||||
## Wanderer Integration Setup
|
||||
|
||||
1. Navigate to the AdventureLog settings page.
|
||||
2. Click on the **Integrations** tab.
|
||||
3. Find the **Wanderer** section and input the URL of your Wanderer instance, your username, and password.
|
||||
4. Click the **Connect Account** button to authenticate with your Wanderer instance.
|
||||
|
||||
### Important Notes
|
||||
|
||||
1. The URL to the Wanderer server must be accessible from the AdventureLog server. This means values like `localhost` or `127.0.0.1` will likely cause some issues.
|
||||
2. AdventureLog **does not store your Wanderer credentials**. They are only used to fetch an authorization token for the Wanderer API. This token will last for around 2 weeks before needing to be refreshed. Using the token refreshes the token for another 2 weeks. Should the token expire, you will need to re-enter your credentials in the AdventureLog settings page.
|
||||
|
||||
## Importing Wanderer Trails
|
||||
|
||||
1. Open the create/edit location popup in AdventureLog.
|
||||
2. Naviage to the **Media** tab and scroll down to the **Trail Managment** section.
|
||||
3. Click the **Add Wanderer Trail** button.
|
||||
4. A search input will appear. Type in the name of the trail you want to import.
|
||||
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 AdventureLog! If you encounter any issues or have questions about the integration, feel free to reach out to the AdventureLog community!
|
Loading…
Add table
Add a link
Reference in a new issue