diff --git a/BUILD.md b/BUILD.md index 0f2a22ea1..157f6a4a9 100644 --- a/BUILD.md +++ b/BUILD.md @@ -37,7 +37,7 @@ Headway currently supports fully automatic builds for the following cities: Aachen, Aarhus, Adelaide, Albuquerque, Alexandria, Amsterdam, Antwerpen, Arnhem, Auckland, Augsburg, Austin, Baghdad, Baku, Balaton, Bamberg, Bangkok, Barcelona, Basel, Beijing, Beirut, Berkeley, Berlin, Bern, Bielefeld, Birmingham, Bochum, Bogota, Bombay, Bonn, Bordeaux, Boulder, BrandenburgHavel, Braunschweig, Bremen, Bremerhaven, Brisbane, Bristol, Brno, Bruegge, Bruessel, Budapest, BuenosAires, Cairo, Calgary, Cambridge, CambridgeMa, Canberra, CapeTown, Chemnitz, Chicago, ClermontFerrand, Colmar, Copenhagen, Cork, Corsica, Corvallis, Cottbus, Cracow, CraterLake, Curitiba, Cusco, Dallas, Darmstadt, Davis, DenHaag, Denver, Dessau, Dortmund, Dresden, Dublin, Duesseldorf, Duisburg, Edinburgh, Eindhoven, Emden, Erfurt, Erlangen, Eugene, Flensburg, FortCollins, Frankfurt, FrankfurtOder, Freiburg, Gdansk, Genf, Gent, Gera, Glasgow, Gliwice, Goerlitz, Goeteborg, Goettingen, Graz, Groningen, Halifax, Halle, Hamburg, Hamm, Hannover, Heilbronn, Helsinki, Hertogenbosch, Huntsville, Innsbruck, Istanbul, Jena, Jerusalem, Johannesburg, Kaiserslautern, Karlsruhe, Kassel, Katowice, Kaunas, Kiel, Kiew, Koblenz, Koeln, Konstanz, LakeGarda, LaPaz, LaPlata, Lausanne, Leeds, Leipzig, Lima, Linz, Lisbon, Liverpool, Ljubljana, Lodz, London, Luebeck, Luxemburg, Lyon, Maastricht, Madison, Madrid, Magdeburg, Mainz, Malmoe, Manchester, Mannheim, Marseille, Melbourne, Memphis, MexicoCity, Miami, Minsk, Moenchengladbach, Montevideo, Montpellier, Montreal, Moscow, Muenchen, Muenster, NewDelhi, NewOrleans, NewYork, Nuernberg, Oldenburg, Oranienburg, Orlando, Oslo, Osnabrueck, Ostrava, Ottawa, Paderborn, Palma, PaloAlto, Paris, Perth, Philadelphia, PhnomPenh, Portland, PortlandME, Porto, PortoAlegre, Potsdam, Poznan, Prag, Providence, Regensburg, Riga, RiodeJaneiro, Rostock, Rotterdam, Ruegen, Saarbruecken, Sacramento, Saigon, Salzburg, SanFrancisco, SanJose, SanktPetersburg, SantaBarbara, SantaCruz, Santiago, Sarajewo, Schwerin, Seattle, Seoul, Sheffield, Singapore, Sofia, Stockholm, Stockton, Strassburg, Stuttgart, Sucre, Sydney, Szczecin, Tallinn, Tehran, Tilburg, Tokyo, Toronto, Toulouse, Trondheim, Tucson, Turin, UlanBator, Ulm, Usedom, Utrecht, Vancouver, Victoria, WarenMueritz, Warsaw, WashingtonDC, Waterloo, Wien, Wroclaw, Wuerzburg, Wuppertal, Zagreb, Zuerich -#### Build procedure. +#### Build procedure This approach will download all the mapping data you need automatically, but only works for the pre-defined metro areas above. @@ -62,6 +62,16 @@ To build Headway for a custom area, you just need to provide your own OSM extrac The process is largely the same as above. After downloading your OSM extract, move it to the project root (in the same directory as this BUILD.md), and wherever you see `with-area Amsterdam` in the build scripts, change it to `with-area YourArea --local-pbf ./your-area.osm.pbf`. +#### 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: + +1. Put your addresses file at `services/myadds.geojson` +2. Put a line for your area in `services/areas.csv`: `MyArea,NK,100.0 100.0 200.0 200.0,myadds.geojson` +3. 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. + +After rebuilding containers and assets, your addresses should now be indexed in Pelias and included in results. + ## Docker-compose restarts Because Headway's docker-compose configuration uses init containers to populate a docker volume containing internal data, rebuilding the data for a metro area won't update existing containers. It's necessary to run `docker compose down --volumes` to re-initialize the data in the init containers. diff --git a/bin/build b/bin/build index 8c8020c2a..9faec235e 100755 --- a/bin/build +++ b/bin/build @@ -45,4 +45,4 @@ if [ -d "$TRANSIT_CONFIG_DIR" ]; then bin/build-transit "$CONFIG_DIR" fi -echo "Next, run: git co . && k8s/bin/regenerate-all" +echo "You can now regenerate kubernetes deployments by running: git co . && k8s/bin/regenerate-all"