-
Notifications
You must be signed in to change notification settings - Fork 18
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
Add full documentation for image #13
base: main
Are you sure you want to change the base?
Conversation
I think it's something we can start to consider. I did some changes about I created a separate This way we could have 2 README, with the main README of this repository explaining how to build manually images, run tests, develop & contribute, tools doc, etc, focusing more on image development. With the main README which still link to |
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.
Some minor comments inline. I would suggest we get this ready, but not publish it before we are capable of publishing the images described here.
Co-authored-by: Patrick Lodder <patricklodder@users.noreply.github.com>
In my opinion, it would be interesting to add this documentation when it's ready. For now, it's stated in big that the project is under development (we can add it at the top of this doc too), if someone come here he could be aware of this and still try to play with the image. Maybe some potential contributor could come and have something a bit documented to try. If someone follows the doc, he will be quickly stopped by not being able to download the image from For me we should even add a link into the main repo, saying it's not finished, but a beginning of a Dockerfile is testable (but definitively unstable, available for development only). It would facilitate people participation. |
Create a draft for the image documentation. Can be the base to use for the readme available both from GitHub and from DockerHub.
You can have an overview of the result on the following Docker Hub repository.
Inspired by documentation of official Docker Hub images.
I want also to discuss (at least) the following line:
When using
docker exec
, commands are launched as root. Idk if we specify to use a user ? We may specify to use the cli a different way, by creating another a new container for example.Edit: Executable launched with
docker exec
are actually underdogecoin
user rights, because I've setuid binaries.docker exec
start as root and then switch to user.