summaryrefslogtreecommitdiff
path: root/docs/contributing/build-vyos.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-04-01 18:24:07 +0200
committerGitHub <noreply@github.com>2020-04-01 18:24:07 +0200
commitfcfded7cc5ebcba1b5d0693dbcb8f5681f213dc8 (patch)
tree19073d95b1a8adeec924a29b1e40d802d3f5df76 /docs/contributing/build-vyos.rst
parent4f9e7c81d77ad439636e75078d27880a9a2fc62b (diff)
parentc62cf4e425b730a074029dfb964deddb7a7e8ca2 (diff)
downloadvyos-documentation-fcfded7cc5ebcba1b5d0693dbcb8f5681f213dc8.tar.gz
vyos-documentation-fcfded7cc5ebcba1b5d0693dbcb8f5681f213dc8.zip
Merge pull request #225 from niklasea/fix-docker-group-recommendation
build.rst: Do not recommend using docker group
Diffstat (limited to 'docs/contributing/build-vyos.rst')
-rw-r--r--docs/contributing/build-vyos.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst
index 28d7b96d..5c7f5205 100644
--- a/docs/contributing/build-vyos.rst
+++ b/docs/contributing/build-vyos.rst
@@ -29,10 +29,10 @@ Installing Docker_ and prerequisites:
$ apt-get update
$ apt-get install -y docker-ce
-To be able to use Docker_, the current non-root user should be added to the
+To be able to use Docker_ without ``sudo``, the current non-root user can be added to the
``docker`` group by calling: ``usermod -aG docker yourusername``
-.. note:: It is recommended to use that non-root user for the remaining steps.
+.. note:: Doing so grants privileges equivalent to the ``root`` user! It is recommended to remove the non-root user from the ``docker`` group after building the VyOS ISO. See also https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user
.. note:: The build process needs to be built on a local file system, building
on SMB or NFS shares will result in the container failing to build properly!