From 435d02e166b4c2bf8dbd87bce01b5c3183c4d601 Mon Sep 17 00:00:00 2001 From: Wouter Born Date: Wed, 4 Feb 2026 17:39:14 +0100 Subject: [PATCH] Revert "Remove references to old raster map implementation (#134)" This reverts commit ee43f151d2bc65e8d1cd5beb4b07675b99f7819b. --- .../docker-compose-profiles.md | 2 +- docs/developer-guide/working-on-maps.md | 23 +++++++++++++++++-- docs/user-guide/manager-ui/appearance.md | 8 +++---- 3 files changed, 26 insertions(+), 7 deletions(-) diff --git a/docs/developer-guide/docker-compose-profiles.md b/docs/developer-guide/docker-compose-profiles.md index 18ef8705..d2b14db0 100644 --- a/docs/developer-guide/docker-compose-profiles.md +++ b/docs/developer-guide/docker-compose-profiles.md @@ -11,7 +11,7 @@ The following services are used by the main OpenRemote code base: * manager - Runs the OpenRemote Manager (by default depends on PostgreSQL and Keycloak) * postgresql - PostgreSQL DB * keycloak - Keycloak identity provider service -* map - tileserver-gl service that is used for serving map tiles (not required) +* map - tileserver-gl service that is used for serving raster map tiles (only needed for UI components/apps that use mapbox-js) ## Docker Compose profiles Docker Compose profiles (Docker Compose `.yml` files) are used to configure and start required services; the standard profiles are located in the profile folder of the main [OpenRemote repository](https://github.com/openremote/openremote/tree/master/profile) although the `demo` profile is in the root of the repo. diff --git a/docs/developer-guide/working-on-maps.md b/docs/developer-guide/working-on-maps.md index 8c38035d..9084c1b5 100644 --- a/docs/developer-guide/working-on-maps.md +++ b/docs/developer-guide/working-on-maps.md @@ -4,9 +4,9 @@ sidebar_position: 6 # Working on maps -## MapLibre GL +## Vector maps (Mapbox GL) -The manager has built in support for `MapLibre GL` and can serve vector tile data. Tiles can be configured from the appearance page or through a custom deployment. Please ensure to check the following: +The manager has built in support for `Mapbox GL` and can serve vector tile data. Tiles can be configured from the appearance page or through a custom deployment. Please ensure to check the following: ### Uploading MBTiles @@ -59,6 +59,25 @@ json|{...} +## Raster maps (Mapbox JS) +If you are working on raster maps (Mapbox JS) then you will need to have the `map` Docker container running, this container serves the raster map tiles from the vector map data. + +The container can be started by using the `dev-map.yml` profile (see [here](docker-compose-profiles.md)) or you can add a `map` service to an existing custom project profile (copy the `dev-map.yml` as a template). + +The manager acts as a reverse proxy for the `map` service and in order to configure the manager to serve raster tiles you need to set the following environment variables: + +```shell +MAP_TILESERVER_HOST=localhost +MAP_TILESERVER_PORT=8082 +MAP_TILESERVER_REQUEST_TIMEOUT=10000 +``` + +:::note + +By default `MAP_TILESERVER_HOST` is `null` which means the reverse proxy is disabled + +::: + ## Downloading maps and extracting smaller tilesets We currently do not have our own pipeline for extracting/converting OSM data into vector tilesets but depend on the extracts offered on [openmaptiles.org](https://openmaptiles.com/downloads/). You can download the vector `mbtiles` file that contains the bounding box of interest. diff --git a/docs/user-guide/manager-ui/appearance.md b/docs/user-guide/manager-ui/appearance.md index 42a4e6fd..6b2d3397 100644 --- a/docs/user-guide/manager-ui/appearance.md +++ b/docs/user-guide/manager-ui/appearance.md @@ -401,8 +401,8 @@ This is what the --or-app-colors look like in the demo deployment: } } ``` -**Rules - Controls:** -Set which types of rules are available (for users with the correct permissions), and which actions a rule can perform. +**Rules - Controls:** +Set which types of rules are available (for users with the correct permissions), and which actions a rule can perform. ```json { "pages": { @@ -426,7 +426,7 @@ Set which types of rules are available (for users with the correct permissions), } } ``` -**Rules - When-Then:** +**Rules - When-Then:** Set which asset types are excluded from the list of asset types that can be selected in the When-Then rule. Additionally you can set per asset (or all '*') which attributes should be excluded from the select list. ```json { @@ -561,7 +561,7 @@ OpenRemote picks how to render the map based on the configurations set in the fo ::: :::warning -Not all Map/Tile providers are fully supported, please check the provider supports MapLibre (see [MapLibre providers](https://github.com/maplibre/awesome-maplibre?tab=readme-ov-file#maptile-providers)). +Not all Map/Tile providers are fully supported, please check the provider supports MapLibre (see [maplibre providers](https://github.com/maplibre/awesome-maplibre?tab=readme-ov-file#maptile-providers)). ::: The following tile servers have been tested.