Introducing our new CEO Don Johnson - Read More

opensearchproject/opensearch-maps-server

Verified Publisher

By opensearchproject

Updated over 1 year ago

The Official Docker Image of OpenSearch Maps Server (https://opensearch.org/)

Image
Data Science
Integration & Delivery
Monitoring & Observability
3

2.0K

Quick Reference:

Maintained by: OpenSearch team
Need help? Ask questions and discuss on our community forum
Need to file issues? Use our issue tracker to report problems with maps server builds or the Docker images

What is OpenSearch Maps Server?

The self-host maps server for OpenSearch Dashboards allows users to access the default maps service in air-gapped environments. OpenSearch-compatible map URLs include a map manifest with map tiles and vectors, the map tiles, and the map vectors.

How to pull this image?

You can pull the OpenSearch Maps Server Docker image just like any other image:

docker pull opensearch/opensearch-maps-server

See DockerHub for a list of all available versions.

How to use this image?

Set up the server

You must set up the map tiles before running the server. You have two setup options: Use the OpenSearch-provided maps service tiles set, or generate the raster tiles set.

Option 1: Use the OpenSearch-provided maps service tiles set

Create a Docker volume to hold the tiles set:

docker volume create tiles-data

Download the tiles set from the OpenSearch maps service. Two planet tiles sets are available based on the desired zoom level:

The planet tiles set for zoom level 10 (2 GB compressed/6.8 GB uncompressed) is approximately 10 times larger than the set for zoom level 8 (225 MB compressed/519 MB uncompressed). {: .note}

docker run \
    -e DOWNLOAD_TILES=https://maps.opensearch.org/offline/planet-osm-default-z0-z8.tar.gz \
    -v tiles-data:/usr/src/app/public/tiles/data/ \
    opensearch/opensearch-maps-server \
    import
Option 2: Generate the raster tiles set

To generate the raster tiles set, use the raster tile generation pipeline and then use the tiles set absolute path to create a volume to start the server.

Start the server

Use the following command to start the server using the Docker volume tiles-data. The following command is an example using host URL "localhost" and port "8080":

docker run \
    -v tiles-data:/usr/src/app/public/tiles/data/ \
    -e HOST_URL='http://localhost' \
    -p 8080:8080 \
    opensearch/opensearch-maps-server \
    run

Or, if you generated the raster tiles set, run the server using that tiles set:

docker run \
    -v /absolute/path/to/tiles/:/usr/src/app/dist/public/tiles/data/ \
    -p 8080:8080 \
    opensearch/opensearch-maps-server \
    run

To access the tiles set, open the URLs in a browser on the host or use the curl command curl http://localhost:8080/manifest.json.

Confirm the server is running by opening each of the following links in a browser on your host or with a curl command (for example, curl http://localhost:8080/manifest.json).

  • Map manifest URL: http://localhost:8080/manifest.json
  • Map tiles URL: http://localhost:8080/tiles/data/{z}/{x}/{y}.png
  • Map tiles demo URL: http://localhost:8080/

Use the self-host maps server with OpenSearch Dashboards

You can use the self-host maps server with OpenSearch Dashboards by either adding the parameter to opensearch_dashboards.yml or configuring the default WMS properties in OpenSearch Dashboards.

Option 1: Configure opensearch_dashboards.yml

Configure the manifest URL in opensearch_dashboards.yml:

map.opensearchManifestServiceUrl: "http://localhost:8080/manifest.json"

Option 2: Configure Default WMS properties in OpenSearch Dashboards
  1. On the OpenSearch Dashboards console, select Stack Management > Advanced Settings.
  2. Locate visualization:tileMap:WMSdefaults under Default WMS properties.
  3. Change "enabled": false to "enabled": true and add the URL for the valid map server.

Related links

How is OpenSearch Maps Server licensed?

OpenSearch Maps Server are licensed under the Apache, Version 2.0 license. Tiles are generated per Terms of Use for Natural Earth vector map data and Copyright and License for OpenStreetMap.

How to contribute?

OpenSearch is and will remain 100% open source under the Apache 2.0 license. As the project grows, we hope you will join us and contribute. We want to make it easy for you to get started and remove friction — no lengthy Contributor License Agreement — so you can focus on writing great code. Checkout the OpenSearch website to know more.

Docker Pull Command

docker pull opensearchproject/opensearch-maps-server