Skip to content

Latest commit

 

History

History
75 lines (44 loc) · 6.58 KB

BUILD.md

File metadata and controls

75 lines (44 loc) · 6.58 KB

Building Headway

Setting up your own Headway instance should be fairly straightforward if you follow these docs. Feel free to open bugs if things go wrong, or submit PRs to improve the project!

There is a script contributed by Santiago Crespo that will automatically deploy Headway as a systemd service on Debian, but it has not been widely tested yet. See contrib/DEBIAN_BUILD.md for details.

Prerequisites: Install Dagger.

Option 1: Building from a pre-configured city

Option 2: Building from your own OSM extract

Option 3: Building Headway for the whole planet

Install Dagger

Headway processes data and builds its containers for hosting using Dagger. Dagger is a build system for orchestrating containerized workflows.

Instructions for installing Dagger can be found here: https://docs.dagger.io/install

Dagger is open source and free to use locally without requiring any accounts or cloud services.

Supported Build Methods

Headway can be built using a BBBike extract if one exists for a metro area you're interested in, or you can supply your own .osm.pbf file to cover areas that BBBike doesn't cover, or larger areas like US states or European countries.

Building Headway from a supported BBBike extract

This section pertains to builds from BBBike extracts. Skip this if you know you need to bring your own OpenStreetMap extract.

Currently supported cities

Headway currently supports fully automatic builds for the following cities:

Supported 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.

This approach will download all the mapping data you need automatically, but only works for the pre-defined metro areas above.

  1. Pick a metro area from the list above, like "Amsterdam" or "Denver". These values are case-sensitive. In all the examples, replace "Amsterdam" with your metro area of choice.
  2. Configuration is managed per build directory in builds/<Area>. Copy a template build directory: cp -r builds/Bogota builds/Amsterdam, review and edit builds/Amsterdam/.env
  3. Execute bin/build builds/Amsterdam to build data artifacts
  4. (Optional) Set up transit routing. Note: This dramatically increases hardware requirements for large metro areas.
    1. Find nearby transit schedules by running bin/export-nearby-transit-feeds builds/Amsterdam
    2. Examine builds/Amsterdam/transit/Amsterdam.gtfs_feeds.csv and manually edit it if necessary to curate GTFS feeds. Some may have errors, and many may be useless for your purposes.
    3. Build transit routing with bin/build-transit builds/Amsterdam
  5. Start services from the build directory by running: cd builds/Amsterdam && docker compose -f ../../docker-compose.yaml up -d
  6. This will bring up the headway stack with a web frontend on port 8080.
  7. (For https and non-default port use only) reverse-proxy traffic to port 8080.

That's it!

There are some experimental kubernetes configs in k8s/configs, but they are pretty specific to my own needs at this point.

Building Headway from your own OSM extract

To build Headway for a custom area, you just need to provide your own OSM extract (.osm.pbf).

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.

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.

When running docker compose commands, make sure to run them from the build directory (e.g., cd builds/Amsterdam && docker compose -f ../../docker-compose.yaml down --volumes) so they use the correct .env file, or use the integration test helper: tests/integration/stop-services.sh builds/Amsterdam

This is necessary whenever you rebuild the data for a metro area, or change which area you're serving data for in the builds/<area>/.env file.

Full-planet considerations

See FULL_PLANET.md.