-
Notifications
You must be signed in to change notification settings - Fork 687
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 detail about membership of the docker group in Ubuntu/Debian quickstart. #3815
Conversation
@@ -39,6 +39,11 @@ be installed via the official documentation links: | |||
.. _`Docker CE for Ubuntu`: https://docs.docker.com/install/linux/docker-ce/ubuntu/ | |||
.. _`Docker CE for Debian`: https://docs.docker.com/install/linux/docker-ce/debian/ | |||
|
|||
.. warning:: | |||
|
|||
The official documentation currently misses the detail that the user needs |
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.
By "official documentation" do you mean SecureDrop's or Docker's? Additionally, all commands can be sudo
'd which is what Docker recommends since having a user in the docker
group is actually a security hole as it effectively means commands can be run as root.
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.
Aha... I meant dockers docs.
I didn't see the instructions for using sudo
in their docs and the example commands I read in both docker and SecureDrop suggest (to me) that sudo
wasn't expected, hence this change. However, please disregard this change given the security concerns of being in the docker
group. In any case, would be good to know what advice to give (I was just logging this as I worked my way through the instructions). Thanks!
|
||
The official documentation currently misses the detail that the user needs | ||
to be in the ``docker`` group. This is easily achieved with | ||
``sudo adduser $USER docker`` and restarting your session. |
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.
Isn't this be sudo adduser $USER -G docker
?
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.
I don't think so... (from adduser --help
):
adduser USER GROUP
Add an existing user to an existing group
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.
That is not the case for Fedora/CentOS/RHEL world. This command will not work :)
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.
But, this is for Ubuntu/Debian, so skip this :)
Rather than include steps ourselves, we should link out to upstream docs wherever possible, to reduce maintenance burden on ourselves. I suggest the following patch in lieu of the "warning" box:
Can you give that a shot, @ntoll, and see if it clarifies the setup for you? |
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.
Suggest changing the warning box to a link out to the group mgmt docs in upstream official Docker docs.
+1 Fixing now. |
good to go @conorsch? |
conor's comment was specific and addressed by the PR author
thanks @ntoll! |
Status
Ready for review.
Description of Changes
A minor documentation edit so docker related installation / setup has complete steps. Will save someone, somewhere 15 minutes of Google-ing.
Testing
Build the docs and visit
/development/setup_development.html
to check.Deployment
Any special considerations for deployment?
None that I know of.
Checklist
If you made changes to the server application code:
make ci-lint
) and tests (make -C securedrop test
) pass in the development containerIf you made changes to
securedrop-admin
:make -C admin test
) pass in the admin development containerIf you made changes to the system configuration:
If you made non-trivial code changes:
If you made changes to documentation:
make docs-lint
) passed locally