Skip to content

docs: clarify build procedures#406

Open
3nprob wants to merge 2 commits intoheadwaymaps:mainfrom
3nprob:misc-docs-log
Open

docs: clarify build procedures#406
3nprob wants to merge 2 commits intoheadwaymaps:mainfrom
3nprob:misc-docs-log

Conversation

@3nprob
Copy link
Contributor

@3nprob 3nprob commented Dec 11, 2025

  • bin/build is very encouraging about running k8s/bin/regenerate-all. Reword the message to make it more obvious that it is only relevant for kubernetes users.
  • BUILD.md: Add rudimentary instructions for how to use a custom openaddresses file

@3nprob 3nprob marked this pull request as ready for review December 11, 2025 05:53

#### OpenAddresses address mappings

By default, a planet-wide address database is downloaded from [OpenAddresses](https://openaddresses.io/). You can supply your own addresses (for example exports from https://openaddresses.io) in either CSV or GeoJSON format. To do so, the file needs to be provided to the `openaddresses` container and configured in `csv/areas.csv`. For example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default, a planet-wide address database is downloaded

That should be true only for planet builds. Smaller builds should not include any openaddress data, unless it's been specified in the service/areas.csv. Are you seeing otherwise?

Modify dagger/pelias.go to include your file by adding a WithFile("/data/openaddresses/myadds.geojson", p.Pelias.Headway.ServicesDir.File("myadds.geojson"). line to the ImportOpenAddresses container.

It should be sufficient to add the OpenAddress file names to the service/areas.csv (like I have for Seattle). Running the build should then download the data from OpenAddresses. It is not necessary to manually download and then edit the dagger code.

Or is there some other use case I'm not considering?

In any case, it'd be good to have this better documented, and it might be nice to encourage people to upstream any mappings they need in that file.


Long ago I actually started an experiment to dynamically download the OA data by bounding box: main...mkirk/openaddresses-downloader

...might be nice to revive that some day.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants