docs: add trek (#2879)
* add trek * re-structure, validate steps, add images * adjust image4s * fix toc * validate steps, optimize structure, add images * submit missing files * address comments * refine image border * optimize image sizes * opt image size * add old name in meta * address comments --------- Co-authored-by: Power-One-2025 <zhengchunhong@bytetrade.io>
|
|
@ -213,6 +213,17 @@ export const useCaseSidebar: DefaultTheme.Sidebar = {
|
|||
text: "Komga",
|
||||
link: "/use-cases/komga",
|
||||
},
|
||||
{
|
||||
text: "TREK (NOMAD)",
|
||||
link: "/use-cases/trek",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
text: "Advanced settings",
|
||||
link: "/use-cases/trek-advanced-settings",
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -203,6 +203,17 @@ export const useCaseSidebar: DefaultTheme.Sidebar = {
|
|||
text: "Komga",
|
||||
link: "/zh/use-cases/komga",
|
||||
},
|
||||
{
|
||||
text: "TREK (NOMAD)",
|
||||
link: "/zh/use-cases/trek",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
text: "Advanced settings",
|
||||
link: "/zh/use-cases/trek-advanced-settings",
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
|
|
|
|||
BIN
docs/public/images/manual/use-cases/trek-2fa-admin.png
Normal file
|
After Width: | Height: | Size: 113 KiB |
BIN
docs/public/images/manual/use-cases/trek-2fa-backup-codes.png
Normal file
|
After Width: | Height: | Size: 128 KiB |
BIN
docs/public/images/manual/use-cases/trek-2fa-disable.png
Normal file
|
After Width: | Height: | Size: 135 KiB |
BIN
docs/public/images/manual/use-cases/trek-2fa-enable.png
Normal file
|
After Width: | Height: | Size: 96 KiB |
BIN
docs/public/images/manual/use-cases/trek-2fa-login.png
Normal file
|
After Width: | Height: | Size: 220 KiB |
BIN
docs/public/images/manual/use-cases/trek-2fa-member-enable.png
Normal file
|
After Width: | Height: | Size: 296 KiB |
BIN
docs/public/images/manual/use-cases/trek-2fs-disable-all.png
Normal file
|
After Width: | Height: | Size: 93 KiB |
BIN
docs/public/images/manual/use-cases/trek-add-note.png
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
docs/public/images/manual/use-cases/trek-api-key-settings.png
Normal file
|
After Width: | Height: | Size: 270 KiB |
BIN
docs/public/images/manual/use-cases/trek-auth-level.png
Normal file
|
After Width: | Height: | Size: 107 KiB |
BIN
docs/public/images/manual/use-cases/trek-backup-auto.png
Normal file
|
After Width: | Height: | Size: 132 KiB |
BIN
docs/public/images/manual/use-cases/trek-backup-manual.png
Normal file
|
After Width: | Height: | Size: 122 KiB |
BIN
docs/public/images/manual/use-cases/trek-budget-category.png
Normal file
|
After Width: | Height: | Size: 48 KiB |
BIN
docs/public/images/manual/use-cases/trek-budget-table.png
Normal file
|
After Width: | Height: | Size: 100 KiB |
BIN
docs/public/images/manual/use-cases/trek-budget.png
Normal file
|
After Width: | Height: | Size: 187 KiB |
BIN
docs/public/images/manual/use-cases/trek-collaboration.png
Normal file
|
After Width: | Height: | Size: 169 KiB |
BIN
docs/public/images/manual/use-cases/trek-control-hub.png
Normal file
|
After Width: | Height: | Size: 148 KiB |
|
After Width: | Height: | Size: 243 KiB |
BIN
docs/public/images/manual/use-cases/trek-create-api-key.png
Normal file
|
After Width: | Height: | Size: 172 KiB |
BIN
docs/public/images/manual/use-cases/trek-create-oauth-client.png
Normal file
|
After Width: | Height: | Size: 96 KiB |
BIN
docs/public/images/manual/use-cases/trek-create-trip.png
Normal file
|
After Width: | Height: | Size: 95 KiB |
BIN
docs/public/images/manual/use-cases/trek-create-user.png
Normal file
|
After Width: | Height: | Size: 100 KiB |
BIN
docs/public/images/manual/use-cases/trek-documents.png
Normal file
|
After Width: | Height: | Size: 104 KiB |
BIN
docs/public/images/manual/use-cases/trek-enable-mapapi.png
Normal file
|
After Width: | Height: | Size: 215 KiB |
BIN
docs/public/images/manual/use-cases/trek-env-vars.png
Normal file
|
After Width: | Height: | Size: 145 KiB |
BIN
docs/public/images/manual/use-cases/trek-export-pdf.png
Normal file
|
After Width: | Height: | Size: 208 KiB |
BIN
docs/public/images/manual/use-cases/trek-google-login.png
Normal file
|
After Width: | Height: | Size: 183 KiB |
BIN
docs/public/images/manual/use-cases/trek-google-oauth-id.png
Normal file
|
After Width: | Height: | Size: 86 KiB |
BIN
docs/public/images/manual/use-cases/trek-google-oauth.png
Normal file
|
After Width: | Height: | Size: 208 KiB |
BIN
docs/public/images/manual/use-cases/trek-google-oauth1.png
Normal file
|
After Width: | Height: | Size: 209 KiB |
BIN
docs/public/images/manual/use-cases/trek-invite-link.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
BIN
docs/public/images/manual/use-cases/trek-invite-user.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
docs/public/images/manual/use-cases/trek-itinerary.png
Normal file
|
After Width: | Height: | Size: 1 MiB |
BIN
docs/public/images/manual/use-cases/trek-oauth-consent-menu.png
Normal file
|
After Width: | Height: | Size: 235 KiB |
BIN
docs/public/images/manual/use-cases/trek-oauth-consent.png
Normal file
|
After Width: | Height: | Size: 458 KiB |
BIN
docs/public/images/manual/use-cases/trek-oidc-config.png
Normal file
|
After Width: | Height: | Size: 143 KiB |
BIN
docs/public/images/manual/use-cases/trek-optimize-route.png
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/public/images/manual/use-cases/trek-packing-list.png
Normal file
|
After Width: | Height: | Size: 82 KiB |
BIN
docs/public/images/manual/use-cases/trek-place-added.png
Normal file
|
After Width: | Height: | Size: 563 KiB |
BIN
docs/public/images/manual/use-cases/trek-place-details.png
Normal file
|
After Width: | Height: | Size: 935 KiB |
BIN
docs/public/images/manual/use-cases/trek-pod-terminal.png
Normal file
|
After Width: | Height: | Size: 223 KiB |
BIN
docs/public/images/manual/use-cases/trek-reservations.png
Normal file
|
After Width: | Height: | Size: 82 KiB |
BIN
docs/public/images/manual/use-cases/trek-trip-created.png
Normal file
|
After Width: | Height: | Size: 133 KiB |
BIN
docs/public/images/manual/use-cases/trek-trip-planner.png
Normal file
|
After Width: | Height: | Size: 957 KiB |
BIN
docs/public/images/manual/use-cases/trek-weather.png
Normal file
|
After Width: | Height: | Size: 567 KiB |
BIN
docs/public/images/manual/use-cases/trek.png
Normal file
|
After Width: | Height: | Size: 316 KiB |
265
docs/use-cases/trek-advanced-settings.md
Normal file
|
|
@ -0,0 +1,265 @@
|
|||
---
|
||||
outline: deep
|
||||
description: Configure advanced settings in TREK on Olares, including OIDC single sign-on, Google API keys, two-factor authentication, and data backups.
|
||||
head:
|
||||
- - meta
|
||||
- name: keywords
|
||||
content: Olares, TREK, NOMAD, SSO, OIDC, Google API, 2FA, backup, restore, configuration, administration, self-hosted
|
||||
app_version: "1.0.0"
|
||||
doc_version: "1.0"
|
||||
doc_updated: "2026-04-16"
|
||||
---
|
||||
|
||||
# Configure advanced settings in TREK
|
||||
|
||||
As your TREK workspace grows, you might want to integrate third-party services, strengthen your account security, and safeguard your data.
|
||||
|
||||
Use TREK's administrative settings to configure single sign-on (SSO), improve map features, enable two-factor authentication (2FA), and set up backups.
|
||||
|
||||
## Learning objectives
|
||||
|
||||
In this guide, you will learn how to:
|
||||
- Set up third-party single sign-on to streamline user logins.
|
||||
- Connect Google API keys to improve map search results.
|
||||
- Secure user accounts with two-factor authentication.
|
||||
- Back up and restore your workspace data.
|
||||
|
||||
## Set up third-party single sign-on
|
||||
|
||||
Simplify the login experience for your travel companions by allowing them to sign in using their existing Google, Apple, or other OIDC provider accounts.
|
||||
|
||||
The following workflow demonstrates how to set up Google SSO.
|
||||
|
||||
### Step 1: Set up a Google Cloud project
|
||||
|
||||
Prepare a dedicated project in Google Cloud to manage your TREK authentication credentials.
|
||||
|
||||
1. Sign in to the [Google Cloud console](https://console.cloud.google.com/auth/clients) using your Google account.
|
||||
2. Create a new project, or select an existing project from the top navigation bar.
|
||||
|
||||
### Step 2: Configure the OAuth consent screen
|
||||
|
||||
Define the authorization screen that users will see when they select to sign in with Google.
|
||||
|
||||
1. In the left sidebar, hover over **APIs & Services**, and then select **OAuth consent screen**.
|
||||
|
||||

|
||||
|
||||
2. On the **OAuth Overview** page, click **Get started**.
|
||||
3. Complete the following project configurations, and then click **Create**:
|
||||
- **App Information**: Enter an app name such as `TREK`, select a user support email, and then click **Next**.
|
||||
- **Audience**: Select **External** as your target audience type, and then click **Next**.
|
||||
- **Contact Information**: Enter an email for receiving project updates, and then click **Next**.
|
||||
- **Finish**: Select **Agree to the Google API Services: User Data Policy**, and then click **Continue**.
|
||||
|
||||
### Step 3: Create the OAuth client ID
|
||||
|
||||
Generate the credentials that TREK needs to communicate with Google.
|
||||
|
||||
1. In the **Metrics** section, click **Create OAuth client**.
|
||||
|
||||

|
||||
|
||||
2. Specify the following settings, and then click **Create**:
|
||||
- **Application type**: Select **Web application**.
|
||||
- **Name**: Enter a name for the OAuth 2.0 client for easy identification.
|
||||
- **Authorized JavaScript origins**: Click **ADD URI**, and then enter your TREK domain.
|
||||
|
||||
For example, `https://8eb06391.alexmiles.olares.com`.
|
||||
- **Authorized redirect URIs**: Click **ADD URI**, and then enter your callback URL in the format of `https://<your-trek-domain>/api/auth/oidc/callback`.
|
||||
|
||||
For example, `https://8eb06391.alexmiles.olares.com/api/auth/oidc/callback`.
|
||||
|
||||

|
||||
|
||||
3. In the **OAuth client created** window, copy the **Client ID** and **Client secret**, and then click **OK**. The new client ID appears on the **OAuth 2.0 Client IDs** page.
|
||||
|
||||

|
||||
|
||||
### Step 4: Connect Google SSO to TREK
|
||||
|
||||
Integrate the credentials you generated in Google Cloud with your TREK admin settings.
|
||||
|
||||
1. Go back to TREK, click your user avatar, and then select **Admin**.
|
||||
2. Click the **Settings** tab, and then locate the **Single Sign-On (OIDC)** panel.
|
||||
3. Specify the following settings, and then click **Save**:
|
||||
- **Display Name**: Enter `Google`.
|
||||
- **Issuer URL**: Enter `https://accounts.google.com`.
|
||||
- **Client ID**: Enter the client ID you copied.
|
||||
- **Client Secret**: Enter the client secret you copied.
|
||||
|
||||

|
||||
|
||||
4. Log out of TREK.
|
||||
5. On the **Sign In** page, select **Sign in with Google**.
|
||||
|
||||

|
||||
|
||||
6. Select your Google account to log in.
|
||||
7. Click **Continue** when prompted to **Sign in to olares.com**. You are now logged in to TREK.
|
||||
|
||||
## Improve map search with Google API keys
|
||||
|
||||
By default, TREK uses basic maps. To display rich place details such as photos, ratings, and opening hours, connect a Google Places API key to your workspace.
|
||||
|
||||
1. Ensure you have created an API key in Google Cloud console. For more information, see [Create an API key](https://docs.cloud.google.com/docs/authentication/api-keys#create).
|
||||
|
||||
:::tip Required Google APIs
|
||||
For the best search experience, ensure that these APIs are enabled: Directions API, Geocoding API, Geolocation API, Maps Elevation API, Maps Embed API, Maps JavaScript API, Maps SDK for Android, Places API, Places API (New), Roads API, and Time Zone API.
|
||||
:::
|
||||
|
||||
2. Log in to TREK, click your user avatar, and then select **Admin**.
|
||||
3. Click the **Settings** tab, and then locate the **API Keys** panel.
|
||||
|
||||

|
||||
|
||||
4. Under **Google Maps API Key**, enter your API key, and then click **Test**. The **Connected** status is displayed, indicating that the key is valid.
|
||||
5. Click **Save**.
|
||||
6. Open your trip and add a new place. The results now display additional context, such as photos, ratings, and opening hours.
|
||||
|
||||

|
||||
<!--
|
||||
1. Sign in to the [Google Cloud Console](https://console.cloud.google.com/auth/clients) using your Google account.
|
||||
2. Create a project or select an existing one.
|
||||
|
||||
### Step 2: Enable search-specific APIs
|
||||
|
||||
A standard map key only shows the map. To improve search, you must Enable the following APIs:
|
||||
- Directions API
|
||||
- Geocoding API
|
||||
- Geolocation API
|
||||
- Maps Elevation API
|
||||
- Maps Embed API
|
||||
- Maps JavaScript API
|
||||
- Maps SDK for Android
|
||||
- Places API
|
||||
- Places API (New)
|
||||
- Roads API
|
||||
- Time Zone API
|
||||
|
||||
1. In the left sidebar, hover over **APIs & Services**, and then select **Library**.
|
||||
2. Search for the API, click it, and then click **Enable**.
|
||||
|
||||

|
||||
|
||||
3. Repeat the same steps to enable all the above APIs.
|
||||
|
||||
### Step 3: Create API keys
|
||||
|
||||
1. In the left sidebar, hover over **APIs & Services**, and then select **Credentials**.
|
||||
2. Click **Create credentials** at the top of the page, and then select **API key**.
|
||||
|
||||

|
||||
|
||||
3. In the **Create API key** panel, configure the following settings:
|
||||
|
||||
- **Name**: Enter a name to identify the API key.
|
||||
- **Select API restrictions**: Select the APIs you just enabled, and then click **OK**.
|
||||
- **Authenticate API calls through a service account**: Do not select.
|
||||
- **Application restrictions**: Select **None**.
|
||||
|
||||

|
||||
|
||||
4. Click **Create**.
|
||||
5. In the **API key created** panel, note down your API key.
|
||||
-->
|
||||
|
||||
## Secure your account with two-factor authentication
|
||||
|
||||
Protect your travel data by adding a second layer of security to your login process. TREK supports TOTP-based two-factor authentication (2FA) using apps like Google Authenticator or Authy.
|
||||
|
||||
### Enable 2FA
|
||||
|
||||
You can choose to secure only your personal account, or mandate 2FA for your entire workspace. You must enable 2FA on your own admin account before you can require it for all your workspace members.
|
||||
|
||||
#### Enable 2FA for your admin account
|
||||
|
||||
Set up an authenticator app to require a 6-digit code alongside your password.
|
||||
|
||||
1. Log in to TREK, click your user avatar, and then select **Settings**.
|
||||
2. Click the **Account** tab, and then locate the **Two-factor authentication (2FA)** section.
|
||||
3. Click **Set up authenticator**.
|
||||
|
||||

|
||||
|
||||
4. Scan the QR code with your authenticator app, enter the generated 6-digit code in TREK, and then click **Enable 2FA**.
|
||||
5. Save the backup codes displayed on screen, store them in a safe place, and then click **OK**.
|
||||
|
||||

|
||||
|
||||
6. Log out of TREK, and then log in again.
|
||||
7. Enter your credentials, and then click **Sign in**.
|
||||
8. Enter the verification code from your authenticator app, and then click **Verify**.
|
||||
|
||||

|
||||
|
||||
#### Enable 2FA for members
|
||||
|
||||
After you enable 2FA on your admin account, you can enforce a mandatory 2FA policy for all members who access your TREK workspace.
|
||||
|
||||
1. In TREK, click the user avatar, and then select **Admin**.
|
||||
2. Click the **Settings** tab, locate the **Require two-factor authentication (2FA)** panel, and then toggle it on.
|
||||
|
||||

|
||||
|
||||
When workspace members log in, TREK directs them to the **Settings** page with the message: `Your administrator requires two-factor authentication. Set up an authenticator app below before continuing`. They must click **Set up authenticator**, scan the QR code, and configure their authenticator app before they can view or edit any trips.
|
||||
|
||||

|
||||
|
||||
### Disable 2FA
|
||||
|
||||
Removing 2FA is a two-part process if it was enforced globally. Turning off the workspace requirement does not automatically delete members' 2FA configurations. Each user must still manually disable it on their own account.
|
||||
|
||||
#### Disable the workspace-wide 2FA requirement
|
||||
|
||||
As an admin, if you enforced 2FA globally, you must turn off this requirement before anyone (including yourself) can disable personal 2FA.
|
||||
|
||||
1. Log in to TREK, select your user avatar, and then select **Admin**.
|
||||
2. Select the **Settings** tab, locate the **Require two-factor authentication (2FA)** section, and then toggle it off.
|
||||
|
||||

|
||||
|
||||
#### Disable 2FA for your personal account
|
||||
|
||||
Remove the 2FA step from your login process.
|
||||
|
||||
:::info Workspace restrictions
|
||||
If you are a workspace member, you cannot disable your personal 2FA until your [admin turns off the global requirement](#disable-the-workspace-wide-2fa-requirement).
|
||||
:::
|
||||
|
||||
1. Log in to TREK using your password and current 2FA code.
|
||||
2. Select your user avatar, and then select **Settings**.
|
||||
3. Select the **Account** tab, and then locate the **Two-factor authentication (2FA)** section.
|
||||
4. Enter your login password.
|
||||
5. Enter the verification code from your authenticator app.
|
||||
6. Select **Disable 2FA**.
|
||||
|
||||

|
||||
|
||||
7. Log out of TREK, and then log in again. The verification step is no longer required.
|
||||
|
||||
## Back up and restore your data
|
||||
|
||||
Regularly save your itineraries, notes, and budgets to prevent data loss. TREK allows you to create manual backups or schedule automated ones.
|
||||
|
||||
### Back up your workspace data
|
||||
|
||||
Choose to trigger a backup immediately or set up a recurring schedule.
|
||||
|
||||
1. Create a backup:
|
||||
|
||||
- **Manual backup**: Click user avatar, select **Admin**, go to the **Backup** tab, and then click **Create Backup**.
|
||||
|
||||

|
||||
|
||||
- **Auto backup**: Configure scheduled backups under **Admin** > **Backups** > **Auto Backup** settings.
|
||||
|
||||

|
||||
2. Click **Download** to save your backup package locally.
|
||||
|
||||
### Restore data from a backup
|
||||
|
||||
If you need to recover lost information, you can upload a previously saved backup file.
|
||||
|
||||
1. On the **Backup** page, click **Upload Backup**, and then select your local package.
|
||||
2. When prompted, review the **Restore Backup** warning, and then confirm your restore to overwrite the current workspace with the backup data.
|
||||
323
docs/use-cases/trek.md
Normal file
|
|
@ -0,0 +1,323 @@
|
|||
---
|
||||
outline: [2, 3]
|
||||
description: Plan trips collaboratively with TREK on Olares. Create itineraries, manage budgets, share with friends, and export travel plans as PDFs.
|
||||
head:
|
||||
- - meta
|
||||
- name: keywords
|
||||
content: Olares, TREK, NOMAD, trip planner, travel planning, collaborative, itinerary, budget, packing list, self-hosted
|
||||
app_version: "1.0.0"
|
||||
doc_version: "1.0"
|
||||
doc_updated: "2026-04-16"
|
||||
---
|
||||
|
||||
# Plan trips collaboratively with TREK (NOMAD)
|
||||
|
||||
TREK (previously NOMAD) is a self-hosted, real-time collaborative trip planner. It combines interactive maps, detailed itineraries, budgeting, packing lists, and team features into a single app. Running TREK on Olares keeps all your travel data private while letting you plan trips together with friends and family.
|
||||
|
||||
## Learning objectives
|
||||
|
||||
In this guide, you will learn how to:
|
||||
- Install and set up TREK on Olares.
|
||||
- Build trip plans, including daily schedules, budgets, and packing lists.
|
||||
- Invite friends and collaborate on travel plans in real time.
|
||||
- Secure your account and back up your travel data.
|
||||
- Configure advanced settings, such as third-party single sign-on (SSO) and map API keys.
|
||||
|
||||
## Install TREK
|
||||
|
||||
1. Open Market and search for "TREK".
|
||||
|
||||

|
||||
|
||||
2. Click **Get**, and then click **Install**.
|
||||
3. When prompted, set the environment variables:
|
||||
- **ADMIN_EMAIL**: Your admin email address.
|
||||
- **ADMIN_PASSWORD**: Your admin password.
|
||||
|
||||
:::info Password requirements
|
||||
The password must be at least 8 characters and include uppercase letters, lowercase letters, and numbers.
|
||||
:::
|
||||
|
||||
4. Click **Confirm** and wait for the installation to finish.
|
||||
|
||||
## Set up TREK
|
||||
|
||||
1. Open TREK from the Launchpad, and then sign in with the email and password you set during installation.
|
||||
2. On the first signin, TREK requires you to reset your password. Enter a new password, and then click **Update password**.
|
||||
|
||||
:::warning
|
||||
Because TREK is a private, self-hosted application, it does not use an automated email password recovery system. If you forget your updated admin password, your account cannot be recovered. To prevent permanently losing access to your workspace and travel data, ensure you store your admin password securely, such as in a password manager.
|
||||
:::
|
||||
|
||||
## Use TREK
|
||||
|
||||
### Create a trip plan
|
||||
|
||||
1. On the home page, click **Create First Trip**.
|
||||
|
||||

|
||||
|
||||
2. Specify the trip details.
|
||||
- **Cover Image**: Upload a cover image for your trip.
|
||||
- **Title**: Specify the name of the trip, such as `Paris Summer 2026`.
|
||||
- **Description**: Enter a description for the trip, such as the overall theme or goal.
|
||||
- **Dates**: Select the start and end dates for your trip.
|
||||
- **Number of Days**: Select the duration of the trip.
|
||||
|
||||
3. Click **Create New Trip**. The trip appears on the **My Trips** page.
|
||||
|
||||

|
||||
|
||||
### Plan your daily itinerary
|
||||
|
||||
Build a day-by-day plan by adding places and organizing them into each day's schedule.
|
||||
|
||||
1. Click the newly created trip to open the trip planner where you start adding places and activities.
|
||||
|
||||

|
||||
|
||||
2. Click **Add Place/Activity**.
|
||||
3. Enter the location to search such as `Eiffel Tower`, click <i class="material-symbols-outlined">search</i>, select the target one from the results list, and then click **Add**.
|
||||
|
||||
The place appears on the right panel in the trip planner.
|
||||
|
||||

|
||||
|
||||
4. Drag the place into a specific day on your itinerary.
|
||||
|
||||
For example:
|
||||
- **Day 1**: Eiffel Tower, Trocadero Gardens
|
||||
- **Day 2**: Louvre Museum, Tuileries Garden
|
||||
- **Day 3**: Notre-Dame Cathedral, Sainte-Chapelle, Latin Quarter
|
||||
|
||||
5. Reorder places within a day by dragging and dropping them.
|
||||
6. Drag an activity across days to shift it to a new date.
|
||||
7. Click a place to add notes or view it on the interactive map.
|
||||
|
||||

|
||||
|
||||
:::tip Route optimization
|
||||
Select **Optimize** to automatically reorder places within a day for the most efficient path. You can also export the route to Google Maps for navigation.
|
||||
|
||||
{width=40%}
|
||||
:::
|
||||
|
||||
### Add trip notes
|
||||
|
||||
Jot down daily reminders, travel ideas, or specific plans on your itinerary.
|
||||
|
||||
1. In your trip planner, click the **Plan** tab.
|
||||
2. Locate the specific day where you want to add a note, and then click <i class="material-symbols-outlined">docs</i>.
|
||||
3. Select an icon that matches the theme of your note.
|
||||
4. In the **Note** field, enter a short title or summary, such as `Buy Metro tickets`.
|
||||
5. In the **Daily Note** field, enter additional details, such as `Get a carnet of 10 tickets at the station before heading to the Louvre`.
|
||||
6. Click **Add**.
|
||||
|
||||
{width=40%}
|
||||
|
||||
### Check weather forecasts
|
||||
|
||||
Click a date in your itinerary to view the weather forecast for that destination. TREK provides up to 16-day forecasts through Open-Meteo (no API key needed), with historical climate averages as a fallback for dates further out.
|
||||
|
||||

|
||||
|
||||
### Log reservations
|
||||
|
||||
Keep track of your flights, accommodations, restaurants, and tour bookings in one place.
|
||||
|
||||
1. In your trip planner, click the **Book** tab.
|
||||
2. Click **Manual Booking** to open the **New Reservation** window.
|
||||
3. Select a **BOOKING TYPE**, such as **Flight**.
|
||||
4. Specify the reservation details. For example, for a hotel stay:
|
||||
|
||||
- **TITLE**: Enter the name of the reservation, such as Hotel Le Meurice.
|
||||
- **LINK TO DAY ASSIGNMENT**: Select a specific day in your itinerary to link this booking.
|
||||
- **DATE and END DATE**: Specify your check-in and check-out dates.
|
||||
- **STATUS**: Select the current state of the booking, such as Pending or Confirmed.
|
||||
- **LOCATION / ADDRESS**: Enter the hotel's address.
|
||||
- **BOOKING CODE**: Enter your confirmation number.
|
||||
- **FILES**: Select **Attach file** to upload your booking confirmation or e-ticket.
|
||||
- **PRICE** and **BUDGET CATEGORY**: enter the total cost to automatically sync this reservation with your trip budget.
|
||||
|
||||
<!---->
|
||||
|
||||
5. Click **Add**.
|
||||
|
||||
### Attach travel documents
|
||||
|
||||
Keep booking confirmations, e-tickets, and travel insurance documents organized by attaching them directly to your itinerary items, places, or reservations. Each file supports a maximum size of 50 MB.
|
||||
|
||||
1. In your trip planner, click the **Files** tab.
|
||||
2. Upload the files to attach.
|
||||
3. In the **Assign File** window, add a note for file, and then select where to link the document, such as a specific day or place.
|
||||
|
||||

|
||||
|
||||
4. Close the window.
|
||||
|
||||
### Track trip expenses
|
||||
|
||||
Keep track of trip expenses with category-based budgeting and multi-currency support.
|
||||
|
||||
1. In your trip planner, click the **Budget** tab.
|
||||
2. Enter a category name for your expenses, such as `Food`, `Transport`, `Accommodation`, or `Activities`.
|
||||
|
||||

|
||||
|
||||
3. Click <i class="material-symbols-outlined">add_2</i>. The budget planner is displayed.
|
||||
|
||||

|
||||
|
||||
4. Specify your preferred currency from the drop-down menu in the top-right corner.
|
||||
5. Specify the details for the expense:
|
||||
|
||||
- **NAME**: Enter the item name, such as `Dinner cruise on the Seine`.
|
||||
- **TOTAL**: Enter the total cost.
|
||||
- **PERSONS**: Enter the number of people sharing the cost.
|
||||
- **DAYS**: Enter the duration of the expense.
|
||||
- **DATE**: Enter the date of the expense.
|
||||
- **NOTE**: Enter additional context.
|
||||
|
||||
6. Select <i class="material-symbols-outlined">add</i> at the end of the row to add the entry.
|
||||
|
||||
TREK automatically calculates the **PER PERSON**, **PER DAY**, and **P. P / DAY** amounts, and updates your total budget on the right.
|
||||
|
||||
7. To add more expense category, enter the category name on the right panel, and then click <i class="material-symbols-outlined">add</i> next to it.
|
||||
|
||||
TREK displays a pie chart breakdown of your spending by category.
|
||||
|
||||

|
||||
|
||||
### Build packing lists
|
||||
|
||||
Create categorized packing lists, assign responsibilities, and track your packing progress.
|
||||
|
||||
1. In your trip planner, click the **Lists** tab.
|
||||
2. Click **Add category**, enter a catetory name such as `Clothing`, `Electronics`, or `Toiletries`, and then click <i class="material-symbols-outlined">check</i> at the end of the row.
|
||||
3. Under your new category, enter the items to pack such as `Walking shoes` and specify the quantity for each item.
|
||||
4. To assign the category to a specific travel companion, click <i class="material-symbols-outlined">person_add</i>.
|
||||
5. Select the checkbox next to an item as you pack it. TREK updates your overall packing progress at the top of the page.
|
||||
|
||||

|
||||
|
||||
6. To save time on future trips, select **Save as template** in the top-right corner to save your current list. When planning your next trip, click **Apply template** to load a saved template to start with a pre-populated checklist.
|
||||
|
||||
### Export your itinerary as PDF
|
||||
|
||||
After your plan is ready, export it as a PDF to share with travel companions or print for offline reference.
|
||||
|
||||
1. Open the trip you want to export.
|
||||
2. Click **PDF** at the top of your itinerary.
|
||||
|
||||
{width=40%}
|
||||
|
||||
3. In the popup window, click **Save as PDF**.
|
||||
|
||||
TREK generates a PDF with a cover page, your day-by-day itinerary, images, and notes.
|
||||
|
||||
## Collaborate with others
|
||||
|
||||
### Invite members to a trip
|
||||
|
||||
Share your trip with friends and family: generate a public link for read-only viewing, or set up user accounts for your travel companions to collaborate on the trip.
|
||||
|
||||
:::info External access and security
|
||||
- To invite people outside your Olares network, first set the **Authentication level** of the app to **Public** in **Settings** > **Applications** > **TREK**.
|
||||
|
||||
{width=70%}
|
||||
|
||||
- Setting the entrance level to Public makes your TREK login page accessible from anywhere on the Internet. Your data remains private, but it relies entirely on the TREK account credentials for protection. Ensure all users set strong passwords.
|
||||
:::
|
||||
|
||||
<Tabs>
|
||||
<template #Option-1:-Share-an-invite-link>
|
||||
|
||||
Generate a read-only link so friends or family can view your itinerary without logging in.
|
||||
|
||||
1. Open a trip, and then click **Share** in the upper-right corner.
|
||||
2. Under **Public Link**, select the trip modules you want to make visible, such as **Map & Plan**, **Bookings**, or **Packing**.
|
||||
3. Click **Create link**.
|
||||
4. Copy the generated link and send it to your travel companions.
|
||||
|
||||

|
||||
</template>
|
||||
<template #Option-2:-Add-collaborators>
|
||||
|
||||
Set up user accounts for your travel companions, and then invite them to actively edit and plan the trip with you.
|
||||
|
||||
1. Click your user avatar in the upper-right corner, and then click **Admin**.
|
||||
2. On the **Users** tab, click **Create User**.
|
||||
|
||||

|
||||
|
||||
3. In the **Create Users** window:
|
||||
|
||||
a. Enter the new member's name, email, and password.
|
||||
|
||||
b. Select the role to assign.
|
||||
|
||||
c. Click **Create User**.
|
||||
|
||||
4. Click **My Trips** in the upper-left corner, and then open the trip you want to share.
|
||||
5. Click **Share** in the upper-right corner.
|
||||
6. In the **Share Trip** window, select the user from the **Invite User** list, and then click **Invite**.
|
||||
|
||||

|
||||
|
||||
The invited member logs in and views the shared trip immediately.
|
||||
|
||||
<!--  -->
|
||||
|
||||
<!--  -->
|
||||
</template>
|
||||
</Tabs>
|
||||
|
||||
### Collaborate in real time
|
||||
|
||||
When members join a trip, all changes sync instantly. Go to the trip's **Collab** tab to access your team dashboard:
|
||||
- **Chat**: Send real-time messages to your travel group.
|
||||
- **Notes**: Post notes visible to all trip members.
|
||||
- **Polls**: Create polls to vote on group decisions.
|
||||
- **What's next**: View your upcoming itinerary.
|
||||
|
||||

|
||||
|
||||
## Next steps
|
||||
|
||||
- [Configure advanced settings in TREK](trek-advanced-settings.md).
|
||||
|
||||
## FAQs
|
||||
|
||||
### I forgot my TREK password. How do I reset it?
|
||||
|
||||
The recovery process depends on the role of your account.
|
||||
- **For a member**
|
||||
|
||||
Contact your TREK admin. The admin can log in to TREK and assign you a new password by going to **Admin** > **Users**.
|
||||
|
||||
- **For an admin**
|
||||
- If you have not changed the initial password, you can view the original credentials you set during installation in Control Hub:
|
||||
|
||||
a. Go to **Browse** > **trek-{username}** > **Deployments** > **trek**, and then click <i class="material-symbols-outlined">edit_square</i>.
|
||||
|
||||

|
||||
|
||||
b. In the YAML editor, find the `containers` section and locate the `ADMIN_EMAIL` and `ADMIN_PASSWORD` environment variables.
|
||||
|
||||

|
||||
|
||||
- If you have changed your initial password, it canont be recovered. To prevent losing access to your workspace and travel data, ensure you store your admin password securely, such as in a password manager.
|
||||
|
||||
### Map search returns no results
|
||||
|
||||
TREK uses OpenStreetMap by default. For more comprehensive search results, add a Google Places API key under **Admin** > **Settings** > **API Keys**. For more information, see [Improve map search with Google API keys](../use-cases/trek-advanced-settings.md#improve-map-search-with-google-api-keys).
|
||||
|
||||
### What is the file upload size limit?
|
||||
|
||||
Each file supports a maximum size of 50 MB.
|
||||
|
||||
Supported formats include `.jpg`, `.jpeg`, `.png`, `.gif`, `.webp`, `.heic`, `.pdf`, `.doc`, `.docx`, `.xls`, `.xlsx`, `.txt`, and `.csv`.
|
||||
|
||||
## Learn more
|
||||
|
||||
- [TREK on GitHub](https://github.com/mauriceboe/NOMAD)
|
||||
1
docs/zh/use-cases/trek-advanced-settings.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
<!--@include: ../../use-cases/trek-advanced-settings.md-->
|
||||
1
docs/zh/use-cases/trek.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
<!--@include: ../../use-cases/trek.md-->
|
||||