Skip to content

osm-regions

OpenStreetMap region extracts from Geofabrik, the regions you choose, verified

What it does

Downloads OpenStreetMap map data for the regions you have chosen, as Geofabrik's .osm.pbf extracts, verifies each file, and keeps it under /usr/local/share/hammunition/data/osm-regions/, one file per region. These are the raw map data; osm-navit converts them for Navit, and later readers reuse the same files without a second download.

Why you would want it

Offline maps have to be on the disk before the network goes away. This is the one place they are fetched, sized in the plan before anything downloads, verified, and removed again by hammunition uninstall, rather than downloaded by hand into a home directory and never checked. It is the verified alternative to fetching extracts from Geofabrik by hand.

Before it will work

Your regions, set in station config with Geofabrik's own region paths, for example hammunition station set --map-regions north-america/us/vermont,north-america/us/new-hampshire. With no regions set this unit is deferred by name and the rest of the install goes ahead; the plan names the command to run. Optionally a freshness mode, hammunition station set --map-freshness yearly|monthly|latest, which defaults to yearly.

How it installs

  • OpenStreetMap regions from Geofabrik (chosen in station config) (ODbL-1.0, https://www.openstreetmap.org/copyright)

Known problems

Freshness decides both which file is fetched and how it is verified. yearly (the default) fetches the region's 1 January snapshot of the current year and monthly the 1st of the current month. A region and snapshot with a row in catalog/data/geofabrik-pins.yaml (its generator lists the 50 US states and DC) is checked against the sha256 Hammunition measured, and the plan says "sha256, pinned by Hammunition". Any other region or snapshot, and every region in latest mode (the dated file Geofabrik's -latest name points to, resolved when the plan is made), is checked only against the MD5 Geofabrik publishes beside it, and the plan says "MD5 from Geofabrik only; not pinned". MD5 catches a damaged download, not a deliberately altered one. The data is under the Open Database License: you may use it freely, but a map or anything else you publish from it must credit "© OpenStreetMap contributors" and say the data is available under the ODbL, and a database you share derived from it must be offered under the ODbL too. Hammunition states that obligation and does not judge your use. A large region is a large download (California is about 1.3 GB), and the size is printed in the plan before it starts.

Keeping it current

  • probe: none
  • strategy: reinstall
  • Set by the freshness mode in station config: yearly moves on 1 January, monthly on the 1st of each month, latest whenever Geofabrik publishes (daily). Reinstalling fetches the current file for each region and replaces the old one.

Where to get help with the software itself

Geofabrik's download server FAQ (https://download.geofabrik.de/technical.html) for the files themselves; problems in the map data are fixed in OpenStreetMap (https://www.openstreetmap.org/fixthemap).

Source: catalog/packages/osm-regions.yaml