Skip to content
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

Additional documentation needed for docker installation #105

Open
terrillmoore opened this issue Aug 10, 2024 · 2 comments
Open

Additional documentation needed for docker installation #105

terrillmoore opened this issue Aug 10, 2024 · 2 comments

Comments

@terrillmoore
Copy link
Contributor

terrillmoore commented Aug 10, 2024

Please add a link to https://docs.docker.com/engine/install/ in README.md, so that people know where to go for instructions. Typically, docker install is not really handled properly by the distribution package manager, and you need to follow the instructions at docker.com for a satisfactory installation.

It would also be nice for the Makefile to check prerequisites and print a message (or point to the README) about what you might want to do if prerequisites are missing.

Also, both the README and the Makefile should point out that if you've just installed Docker, you need to make sure you're in the docker group (adduser, and logout/log in to be sure). Again, it's not hard for the Makefile to check whether you're in the docker group and prompt & exit if not.

@jchonig
Copy link
Contributor

jchonig commented Aug 21, 2024

I can update the README.md with instructions to install docker. And probably update the Makefile to check for prerequisites.

However, the Makefile is now designed to only run under bin/run, so it should only be running inside a docker container.

@terrillmoore
Copy link
Contributor Author

Normally I run makefiles outside docker, and call docker run. That way, the makefile can build the containser etc. It's easy to do docker run and launch a specific ansible command. (Though the command gets long.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants