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

Configuration

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

FieldValue
HostBase URL of your Barrelman instance, e.g. http://localhost:3001. 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.