docs: Document SELinux issues

Initial Docker setup caused me some heartache on Fedora. Briefly
document the issues encountered to help other users.

Signed-off-by: Stephen Finucane <stephenfinucane@hotmail.com>
Reviewed-by: Daniel Axtens <dja@axtens.net>

diff --git a/docs/development.md b/docs/development.md
index 4fe3bef58b5f5534f02432c9fe89e2170e50bc61..2ecb2c4b14ce08c68cb775cbf66479d64a5efe32 100644 (file)
--- a/docs/development.md
+++ b/docs/development.md
@@ -65,6 +65,22 @@ the Docker container, and so should be picked up by the Django auto-reloader.
 For more information on Docker itself, please refer to the [Docker][ref-docker]
 and [docker-compose][ref-compose] documentation.
 
+**NOTE:** If using SELinux, you will need to create a custom SELinux rule to
+allow the Docker process to access your working directory. Run:
+
+    $ chcon -RT svirt_sandbox_file_t $PATCHWORK_DIR
+
+where `$PATCHWORK_DIR` is the absolute patch to the `patchwork` folder created
+when you cloned the repo. For more information, see `man docker run`.
+
+**NOTE:** If you see an error like the below:
+
+    ERROR: Couldn't connect to the Docker daemon at
+    http+docker://localunixsocket - is it running?
+
+ensure you have correctly installed Docker, added your user to the `docker`
+group, and started the daemon, per the [Docker documentation][ref-docker].
+
 ## Vagrant-Based Installation
 
 Patchwork provides a Vagrant-based environment as an alternative to Docker.

diff --git a/tools/docker/entrypoint.sh b/tools/docker/entrypoint.sh
index d8ca7984baf66f81ee678cc3f5ab991dd423f039..5a23fa36b9cbab0f2e26dc19ba718cf3d87897ec 100755 (executable)
--- a/tools/docker/entrypoint.sh
+++ b/tools/docker/entrypoint.sh
@@ -30,6 +30,8 @@ EOF
 if [ ! -f ~patchwork/patchwork/tools/docker/entrypoint.sh ]; then
     echo "The patchwork directory doesn't seem to be mounted!"
     echo "Are you using docker-compose?"
+    echo "If so, you may need to create an SELinux rule. Refer to the"
+    echo "development installation documentation for more information."
     echo "If not, you need -v PATH_TO_PATCHWORK:/home/patchwork/patchwork"
     exit 1
 fi