diff options
| author | Pranav Annam <pranavannam@gmail.com> | 2020-02-12 04:36:14 +0100 |
|---|---|---|
| committer | Daniel Axtens <dja@axtens.net> | 2020-02-17 22:59:57 +1100 |
| commit | 1c31bb59527fb6722a0916248d01ad53e7845c35 (patch) | |
| tree | ff1a51d92e96a75de15ca84c3ee08761da95b019 /docs | |
| parent | ec00daae4d79bf2560034e1b2bc3cf76a98a3212 (diff) | |
| download | patchwork-1c31bb59527fb6722a0916248d01ad53e7845c35.tar patchwork-1c31bb59527fb6722a0916248d01ad53e7845c35.tar.gz | |
docs: set the GID in the .env file
The .env file needs the UID and GID for a working docker-compose build.
If you follow the current instructions, the docker build fails with a
clear error message: 'You must define GID in .env'
It is still good to update documentation to reduce the burden on new
contributors to run into this build failure first.
Signed-off-by: Pranav Annam <pranavannam@gmail.com>
[simply provide bash command in docs, reworked commit message]
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Daniel Axtens <dja@axtens.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/installation.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/development/installation.rst b/docs/development/installation.rst index 03ad67a..0a6e71c 100644 --- a/docs/development/installation.rst +++ b/docs/development/installation.rst @@ -25,11 +25,12 @@ configure Patchwork using Docker: #. Install `docker`_ and `docker-compose`_. #. Create a ``.env`` file in the root directory of the project and store your - ``UID`` attribute there. + ``UID`` and ``GID`` attribute there. .. code-block:: shell $ echo "UID=$UID" > .env + $ echo "GID=`id -g`" >> .env #. Build the images. This will download over 200MB from the internet: |