Parchment Docs
UsageIntegrations

Barrelman

Self-hosted OSM search and spatial engine for Parchment.

Barrelman is a self-hosted OSM geospatial engine that powers Parchment's place search, category lookup, and spatial queries. It is the recommended search provider for installations that want fast, private, offline-capable OSM search.

See the Barrelman setup guide for instructions on running and importing data into Barrelman.


Capabilities

CapabilityDescription
SearchFull-text, fuzzy, abbreviation, and vector search over OSM places
AutocompleteLow-latency typeahead backed by the same search pipeline
Search CategoryBrowse places by OSM preset category (e.g. amenity/cafe)
GeocodingAddress-to-coordinate lookup and reverse geocoding of a dropped pin
Place InfoFetch a single place by OSM type + ID
Spatial ContainsFind which named areas contain a given coordinate
Spatial ChildrenList POIs whose centroids fall inside a given area
TransitLive vehicle positions, route shapes and topology, stop departures, and station detail from GTFS + GTFS-RT feeds
Shared mobilityBikeshare and scooter dock availability from GBFS feeds
IsochronesTravel-time reachability polygons for walking, cycling, driving, and public transit — used by the map's isochrone tool

Barrelman has the highest priority of any geocoding provider, so it serves geocoding whenever it is configured. Reverse geocoding returns the feature at the coordinate hydrated with its full OSM geometry and tags, borrowing the street address the geocoder found at the same spot when the feature has none of its own. If nothing addressable is nearby, it falls back to the smallest administrative area containing the point.

Providers configured below Barrelman — Nominatim, Google Maps, Geoapify — remain as fallbacks for coordinates outside the regions you have imported.


Configuration

In Settings → Integrations, click the settings icon on the Barrelman card.

FieldValue
HostBase URL of your Barrelman instance, e.g. http://localhost:5001. For a publicly deployed instance use the HTTPS URL (e.g. https://barrelman.example.com).
API KeyThe value of BARRELMAN_API_KEY set in Barrelman's .env. Leave blank if no key is configured.

Click Test Connection before saving to confirm Parchment can reach your Barrelman instance.