updates docu

This commit is contained in:
Christian Beutel
2024-12-05 01:04:37 +01:00
parent c611a58195
commit a39c880272
6 changed files with 63 additions and 2 deletions

View File

@@ -56,7 +56,12 @@ export default defineConfig({
{ {
label: 'Custom categories', label: 'Custom categories',
link: '/guides/custom-categories/' link: '/guides/custom-categories/'
}, { },
{
label: 'Customize the map',
link: '/guides/customize-map/'
},
{
label: 'Import/Export', label: 'Import/Export',
link: '/guides/import-export/' link: '/guides/import-export/'
}, { }, {

Binary file not shown.

After

Width:  |  Height:  |  Size: 454 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 370 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 MiB

View File

@@ -62,3 +62,19 @@ In the PocketBase admin panel navigate to `Settings -> Auth providers`. Click th
![wanderer OAuth](../../../assets/guides/wanderer_oauth.png) ![wanderer OAuth](../../../assets/guides/wanderer_oauth.png)
That's it! You should now see your OAuth provider appear in wanderer's login form. Click the button, authorize wanderer, and wait for the authentication to finish. You are now logged in and can use wanderer like any other user. That's it! You should now see your OAuth provider appear in wanderer's login form. Click the button, authorize wanderer, and wait for the authentication to finish. You are now logged in and can use wanderer like any other user.
## Forgot your password?
wanderer offers the option to send password reset emails in case a user forgets his password.
### Prerequisites
To set up password reset emails you will need to access the PocketBase backend. Make sure to forward port 8090 of the `wanderer-db` container. Access the PocketBase admin panel in your browser at `http://<your_pocketbase_url>:8090/_/` and create an admin account.
### Configure SMTP settings
![Pocketbase Mail Settings](../../../assets/guides/pocketbase_mail_settings.png)
Next in the pocketbase admin panel go to Settings -> Mail settings an enable "Use SMTP mail server". Enter the details of your SMTP server and send a test email to ensure your configuration is correct. On the same page you can also adjust the email template of the password reset email.
### Request password reset
Once the SMTP access is configured users can click the "Forgot password" link in the login form. After requesting the reset the user will receive an email with a unique link to reset their password.

View File

@@ -0,0 +1,40 @@
---
title: Customize the map
description: How to customize the map with user defined tile sets
---
wanderer is compatible with any provider of vector tile maps (e.g. CARTO, mapbox, maptiler, or self-hosted OpenMapTiles). Out of the box it comes with 4 different map styles:
1. Open Street Maps
2. Open Topo Maps
3. CARTO Light
4. CARTO Dark
You can switch between these styles by opening the style switcher menu with the button on the right side of every map.
## Custom map styles
![Custom tilesets](../../../assets/guides/custom_tilesets.png)
To further personalize your map, you can add custom map styles by providing a URL to a `style.json` file. This allows you to fully control the maps appearance using your own vector tile styles. Follow these steps to add and use your custom styles:
1. Navigate to `Settings -> Display`.
2. Under the `Tilesets` section, you can add your custom map styles:
- Enter an arbitrary name for your style (this is how it will appear in the style switcher menu).
- Paste the URL pointing to your `style.json` file. This file should define the vector tile style you want to use.
3. Click the + button to save your style.
Once added, your custom style will be available in the style switcher menu, allowing you to quickly apply it to the map.
## Terrain & Hillshading
![Custom tilesets](../../../assets/guides/wanderer_terrain.png)
To enhance wanderer's map visualization, you can add two types of data sources to display 3D Terrain and Hillshading. This is achieved by providing URLs pointing to the required `tiles.json` files. Both the terrain and hillshading data must be in Mapbox TileJSON format and accessible through the provided URLs.
To add the respective URLs navigate to `Settings -> Display` and add them in the `Terrain` section. After adding the terrain & hillshading source, you can explore the 3D map view by interacting with the compass control on the map.
1. Enable 3D terrain with the control on the bottom-right.
2. Locate the compass control in the top-right corner of the map.
3. Click and drag the compass control to tilt the map into 3D mode.
4. Adjust the tilt and rotation as desired to view the terrain in 3D.