Skip to main content

OpenMapX documentation

OpenMapX is a map application for place search, directions, public transit, and map layers. You can use an existing instance or host it on your own infrastructure. The features and geographic coverage available on an instance depend on its enabled integrations, data sources, and services.

What runs on your server​

The core deployment includes the web app, API, PostgreSQL/PostGIS database, Valkey cache, reverse proxy, data-manager, and operations agent. You can add routing, geocoding, transit, and map-tile engines as needed. Some integrations use hosted providers; check their credentials, coverage, licences, and privacy requirements before enabling them.

OpenMapX has two kinds of plugins:

PluginPurposeExamples
ServiceA container that supplies infrastructure or a backend enginePostgreSQL, Valhalla, MOTIS, Photon
IntegrationAn application feature or a provider of data for oneRouting, transit planning, weather, place photos

The CLI renders the Docker Compose deployment from service manifests. Integrations connect application features to those services and to external providers. Read How it works for the deployment model.

Before you choose an instance​

Saved places and other synchronized account data are readable by the instance's server and operator. They are not end-to-end encrypted. External providers also have their own data-use terms. The user-data trust model describes these boundaries; the instance's privacy page identifies its operator and configured sources.

For a problem with the map or a documentation question, see Troubleshooting and help.