Skip to content

Remove references to old raster map implementation #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Ekhorn wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Remove references to old raster map implementation #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/developer-guide/docker-compose-profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 raster map tiles (only needed for UI components/apps that use mapbox-js)
* map - tileserver-gl service that is used for serving map tiles (not required)

## 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.
Expand Down
23 changes: 2 additions & 21 deletions docs/developer-guide/working-on-maps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ sidebar_position: 6

# Working on maps

## Vector maps (Mapbox GL)
## MapLibre GL

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

### Uploading MBTiles

Expand Down Expand Up @@ -59,25 +59,6 @@ json|{...}

</details>

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

Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/manager-ui/appearance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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
{
Expand Down Expand Up @@ -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.
Expand Down