search

headwaymaps / headway

Self-hostable maps stack, powered by OpenStreetMap.
https://about.maps.earth
Apache License 2.0
2.57k stars 60 forks source link

Is there more documentatin besides BUILD.md #282

Closed borys-spiridonov-yal closed 1 year ago

borys-spiridonov-yal commented 1 year ago

Hi, I'm looking into this project and was wondering if there is any documentation besides BUILD.md The readme.md is extremely short and does not explain anything about the project's architecture or how to run it. I'm sorry if I missed something

michaelkirk commented 1 year ago

I agree the project is pretty sparse on architectural documentation. There's also https://about.maps.earth, but there's admittedly not much there.

BUILD.md is intended to be sufficient to get you up and running, but I'm sure it could be improved.

Did you encounter a specific problem? If so can you elaborate on what you tried and what happened?

ellenhp commented 1 year ago

Yeah it's definitely a bit sparse especially compared to what's available for its core services. I wrote some documentation in at the beginning last summer and it's been improved then but I don't the scope has been changed. It might be nice to have a user guide, but it's not clear how many users we have other than the main maps.earth instance.

borys-spiridonov-yal commented 1 year ago

Thanks for your prompt responses. I'm considering using hedwaymeps to host our own maps server instance (mainly to use the API for tiles server and routing). And I was unable to find any information on what is running under the hood of hedwaymeps.

  1. Is it the standard OSM suite apps like Overpass and Nominatim or is it something different?
  2. Does it expose Overpoass API?
  3. What database is in use and can I host the database outside the main app container?
michaelkirk commented 1 year ago

Headway is:

  1. a bunch of other projects stitched together
  2. a consolidated build system for those projects
  3. a web frontend

The various components:

Is it the standard OSM suite apps like Overpass and Nominatim or is it something different?

See above - we don't use overpass or nominatim, but we do use a bunch of other existing software packages.

Does it expose Overpoass API?

n/a - see above

What database is in use and can I host the database outside the main app container?

Our various services are powered by a variety of static file formats optimized for their different purposes — there is no singular database, e.g. postgres. The files we use are generated in a batch fashion from inputs like an osm.pbf exports, WOF extracts, and GTFS feeds using the earthly build system linked above.

borys-spiridonov-yal commented 1 year ago

Thank you, this is super helpful!