Make docker defaults more useful for local testing setup and update documentation #5087
Conversation
SlowMo24
changed the title
|
|
…using 127.0.0.1 instead of localhost
SlowMo24
changed the title
|
Please retry analysis of this Pull-Request directly on SonarCloud. |
…ve traefik to dedicated file. update example.env to according to reviewer comments. Update documentation. Addresses issue hotosm#5313
|
Kudos, SonarCloud Quality Gate passed!
|
|
Thank you @Aadesh-Baral for reviewing. I have updated the config and docker-compose so it uses the same ports as the local development setup. I have also addressed #5313 and simplified the whole docker configuration. Feel free to comment. |
dakotabenjamin
added
the
containerization
|
Hey, thanks for approving. I think there has been a rework of the documentation (there is now a |
|
Related to #5705 |
There was a problem hiding this comment.
This looks good to be merged. cc : @Aadesh-Baral this seems to only affect docker-compose setups and might not interfere with other merge requests in queue. Can we proceed?
@SlowMo24 thank you very much for these changes. We will improve over them in due course, but this is a good starting point for us.
|
Seems like there are some conflicts after-all. I will review this tomorrow and see how we can incorporate these changes into the new docs hierarchy. |
LGTM. Please go ahead. |
|
@mahesh-naxa - could you please verify if some of these issues have been fixed with the recent docker PRs? cc @spwoodcock @dakotabenjamin |
|
The actual config changes aren't required anymore - they have since been updated. The docs in the PR were definitely useful at the time too, but I think the docs and config have changed since then, so it's hard to reconcile. Unfortunately, it may be best to close this PR. So sorry @SlowMo24, I think this fell through the cracks! The contribution was good 🙏 |
|
His docs specifically on how to generate OSM Auth client/secret with screenshots are helpful imo. |
|
This MR was the result of me setting up my own tasking manager instance for a research project that I presented at SotM2022: https://gitlab.gistools.geog.uni-heidelberg.de/giscience/ideal-vgi/osm-multitag . At that time I struggled quite a bit with the documentation but especially with Traefik (see #5313 ). The project is since completed and I currently don't work with it any more (:thinking: should take down that server I set up back then). So I am out of date with your code-base on the topic. Things happen, let's move forward: I am happy to support you (I also gained a bit more knowledge on Docker and Traefik since then ;-) ) Please tell me where you could use support and I will see what I can do. For example I could run the setup procedure again with the current documentation and create issues or MRs where I fail. Yet, I would need some info on who you actually target with the documentation and the docker setup. If it is meant to be your team-documentation and should limit the lottery factor we might think differently about it than if it was meant for what I did: random humans set up their own instance. |
|
Thanks so much for the offer @SlowMo24, very kind of you 😄 Testing our current setup and providing feedback on the config or documentation around it would be a huge help 🙏 Feel free to rebase this or create a new MR/PR as needed & we will be much quicker to review next time! |
This PR updates the docker documentation that seems to lag behind the docker setup development. It does so by adapting the docker-compose defaults as well as the settings (.env) defaults.
In addition it updates and extends the documentation. This documentation update is quite brisk, so feel free to adapt anything where you don't agree. Especially I was not sure what would be the 'best-practice' to get administrator privileges on the self hosted Tasking Manager and how detailed to describe the procedure.
closes #5008