-
Notifications
You must be signed in to change notification settings - Fork 296
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
contrib: Finish Docker documentation. #3045
Conversation
ee47492
to
5b1f1cc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall the documentation looks fine. Theres a bit too much repetition for my taste, e.g. the concept of running as 10000:10000 is explained in detail twice, the dcrctl RPC examples are listed twice, including the caveat about dcrwallet not being installed. I understand the intention is to have a quick summary and a more in-depth explanation, but perhaps some of the duplication can be removed by using links.
Defaulting to always build latest master seems a bit off to me. I believe most users would want to be running a release version and defaulting to the latest release would be more sensible. I notice you've listed that as a TODO though, so I guess that can be left for now.
f2d9d47
to
9da601a
Compare
Thanks for the review!
Good point. Updated to put a link in the overview to the section discussion this to avoid that repetition.
I believe they are all different with the exception of running the container where the important aspect about the DNS names are explained in the I suppose the
Yeah, I wasn't 100% sure on that point since I don't really use docker and why I requested a review from someone who does. I would imagine that it will highly depend on the user which is why I added the TODO since I figured having a choice would cover the various use cases. For example, I pretty much always run Another thing to keep in mind about building a release is that they typically are fairly tightly coupled to the Go version that was the latest at the time of the release, so I suspect that having a release version would really end up needing to have a directory per release version that pulls the specific Go version to build with too. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updates look good.
I guess which version to build and which go version to use really depends on the target audience. Devs probably want latest, people deploying for production probably want release. We can maybe address both just by using params (default to release because devs by their nature are more comfortable changing things via params). That should satisfy devs and also make deployment onto things like Umbrel/Unraid/Proxmox/etc nice and simple.
This updates the contrib/docker/README.md and contrib/docker/Dockerfile to address the remaining outstanding TODOs and finish fleshing out the documentation.
9da601a
to
a3064c1
Compare
This is rebased on #3044.
This updates the
contrib/docker/README.md
andcontrib/docker/Dockerfile
to address the remaining outstanding TODOs and finish fleshing out the documentation.