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

Add docker install requirement in the docs #1354

Open
paulzierep opened this issue Feb 16, 2023 · 3 comments
Open

Add docker install requirement in the docs #1354

paulzierep opened this issue Feb 16, 2023 · 3 comments

Comments

@paulzierep
Copy link
Contributor

paulzierep commented Feb 16, 2023

running planemo test/serve --biocontainers fails if docker is not installed and the user is not part of the docker group, that should be mentioned in the docs

@bgruening
Copy link
Member

@paulzierep please try to get this documented, should be a nice first contribution to planemo.

@mvdbeek
Copy link
Member

mvdbeek commented Feb 16, 2023

  --mulled_containers, --biocontainers
                                  Test tools against mulled containers (forces
                                  --docker). Disables conda resolution unless
                                  any conda option has been set explicitly.

and just above that:

  --docker / --no_docker          Run Galaxy tools in Docker if enabled.
  --docker_cmd TEXT               Command used to launch docker (defaults to
                                  docker).
  --docker_sudo / --no_docker_sudo
                                  Flag to use sudo when running docker.
  --docker_host TEXT              Docker host to target when executing docker
                                  commands (defaults to localhost).
  --docker_sudo_cmd TEXT          sudo command to use when --docker_sudo is

@paulzierep
Copy link
Contributor Author

@mvdbeek I know that part of the docs, and probably it is clear to many people that a docker installation with user rights is required for this. But I think it is also possible that users develop tools without any knowledge of docker at all. And since planemo test --biocontainers can fail (the test is shown as failed) without giving an error message that docker is missing, it would improve UX if the info was given in the installation requirements.

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

No branches or pull requests

3 participants