search

GIScience / openrouteservice

🌍 The open source route planner api with plenty of features.
https://openrouteservice.org
GNU General Public License v3.0
1.43k stars 393 forks source link

Improve docker setup documentation #1084

Open koebi opened 2 years ago

koebi commented 2 years ago

Here's what I think could be improved

Recently, the questions about how to set up with docker are increasing. Most people seem to struggle with the complexity stemming from the jumble of how to mount and configure everything correctly and the interactions of docker-compose.yml, the Dockerfile, the ors-config and the .pbf.

This is currently not super well documented and could definitely be improved.

ihsankurt0 commented 2 years ago

Hi, I think there should be a section as (maybe there is and I didnt see yet) FAQ for Docker Installation. I had a problem (status is not getting ready) related to docker resources settings. It was a pain to find the reason.

koebi commented 2 years ago

Hey, I agree, though I'd hope that most of it can be covered by improving the documentation in itself.

Can you elaborate on what the symptoms, the reason and the fix were for your problem? That way, we can collect all the issues people have and provide reasonable documentation for them :)

ihsankurt0 commented 2 years ago

I am new on docker and openrouteservice. I have tried to follow the documentation. Downloaded a custom pbf file (~379mb) for my country. Firstly: The part "... build your own image either with docker run... " does not mapping the log files to host machine. Secondly: The health request (http://localhost:8080/ors/v2/health) said that the service is not ready. I have checked the catalina logs (I am totally a newbie, it was hard for me :)) and seen a line as "OutOfMemory" error. The solution was on one of the support pages as the question owner written as "I have increased the memory limit of docker". I have tried to increase the memory limit on docker. Then created a smaller pbf (I think there should be a link for osmconvert tool for custom pbfs) nearly ~34mb. After these 2 changes; the system was up.

Also, another suggestion: If the users (newbies like me) wish to use existing image instead of building their own images; there should be a little less technical explanations or screenshots like how to map volumes to host machine or some basic queries on cli for troubleshooting on docker image. For instance, I am not sure how to change JAVA_OPTS yet. Thnks @koebi

yasinahlattci commented 2 years ago

Hİ @ihsankurt0, can you tell me how you solve the log issue? I might be getting the same error. My error is LOGGING FILE DOES NOT EXIST!