diff options
| author | Niklas Elmose Andersen <mail@niklasea.dk> | 2020-03-31 19:18:00 +0200 |
|---|---|---|
| committer | Niklas Elmose Andersen <mail@niklasea.dk> | 2020-03-31 19:18:00 +0200 |
| commit | c62cf4e425b730a074029dfb964deddb7a7e8ca2 (patch) | |
| tree | 9d588d6ee0353e66bf20a3aae4f5b1035f7f0afb /docs/contributing | |
| parent | 14cf1f452da7b1958415b1bc2beaad43316bb729 (diff) | |
| download | vyos-documentation-c62cf4e425b730a074029dfb964deddb7a7e8ca2.tar.gz vyos-documentation-c62cf4e425b730a074029dfb964deddb7a7e8ca2.zip | |
build.rst: Do not recommend using docker group
The documentation for building VyOS currently recommends adding a
non-root user to the docker group. Doing so is equivalent to making
that user root and thus should at least carry a warning.
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/build-vyos.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index d186f05e..63a45c21 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! |