]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
README: add .env file to installation instructions
authorRussell Currey <ruscur@russell.cc>
Wed, 1 May 2019 03:16:43 +0000 (13:16 +1000)
committerDaniel Axtens <dja@axtens.net>
Fri, 3 May 2019 06:09:19 +0000 (16:09 +1000)
Creating the .env file is mentioned in the installation documentation
but not in the README, so following only the steps mentioned there will
fail.  Add this and add a `cd patchwork` in there for good measure so
you could straight up copy paste the steps.

Signed-off-by: Russell Currey <ruscur@russell.cc>
Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
Signed-off-by: Daniel Axtens <dja@axtens.net>
README.rst

index 38c18473645afac9822cdd752594a1ef9682e345..b45c3e6ad54cd99365c9064d5ad075d5f41de1ec 100644 (file)
@@ -61,11 +61,16 @@ environment. To install Patchwork:
 
        $ git clone https://github.com/getpatchwork/patchwork.git
 
-3. Build the images. This will download over 200MB from the internet::
+3. Create a ``.env`` file in the root directory of the project and store your
+   ``UID`` attribute there::
+
+       $ cd patchwork && echo "UID=$UID" > .env
+
+4. Build the images. This will download over 200MB from the internet::
 
        $ docker-compose build
 
-4. Run `docker-compose up`::
+5. Run `docker-compose up`::
 
        $ docker-compose up