aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Finucane <stephenfinucane@hotmail.com>2016-08-30 00:35:40 +0100
committerStephen Finucane <stephenfinucane@hotmail.com>2016-09-01 19:24:46 +0100
commit5bc9ee1503f41de718737906127751a594351897 (patch)
treefde4bcad3a653b4c1172a4b1642997180a994275
parent0d75ce35494f1d27daf58950d57bb6ee866518f1 (diff)
downloadpatchwork-5bc9ee1503f41de718737906127751a594351897.tar
patchwork-5bc9ee1503f41de718737906127751a594351897.tar.gz
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>
-rw-r--r--docs/development.md16
-rwxr-xr-xtools/docker/entrypoint.sh2
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/development.md b/docs/development.md
index 4fe3bef..2ecb2c4 100644
--- 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 d8ca798..5a23fa3 100755
--- 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