Skip to main content

Configuration Reference

osmprj is configured via osmprj.toml in your project directory. The file is created by osmprj init and updated by osmprj add / osmprj remove.

[project] fields

FieldTypeDefaultDescription
database_urlstringPostgreSQL connection URL. Required for sync and status.
data_dirstringOS cache dirDirectory for downloaded PBF files.
log_dirstring./logsDirectory for osm2pgsql log files.
ssdbooltrueSet to false if data_dir is on spinning disk. Raises the flat-nodes threshold from 8 GB to 30 GB.
max_diff_size_mbintegerMaximum diff size in MB for replication updates.

[sources.<name>] fields

FieldTypeDescription
themestringTheme name to use for this source.
schemastringPostgreSQL schema name. Auto-derived from source name if omitted.
pathstringPath to a local PBF file (use instead of a Geofabrik ID).

Example

[project]
database_url = "postgres://user:pass@localhost/osm"
data_dir = "/mnt/data/osm"
ssd = true

[sources.germany]
theme = "shortbread"
schema = "germany"

[sources."europe/france"]
theme = "shortbread-gen"
schema = "france"