diff mbox

[v2,3/4] docs: Document SELinux issues

Message ID BLU436-SMTP90A9F05B5AF53B1261BE04A3E10@phx.gbl
State Accepted
Headers show

Commit Message

Stephen Finucane Aug. 29, 2016, 11:35 p.m. UTC 
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>
---
 docs/development.md        | 16 ++++++++++++++++
 tools/docker/entrypoint.sh |  2 ++
 2 files changed, 18 insertions(+)

Comments

Stephen Finucane Sept. 1, 2016, 6:26 p.m. UTC | #1 
On 30 Aug 00:35, Stephen Finucane wrote:
> 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>

I extended this to included Daniel's reviewed-by, per comments on v1,
and merged this.

Stephen
diff mbox

Patch

diff --git a/docs/development.md b/docs/development.md
index d1267c6..513f87a 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -64,6 +64,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..3014358 100755
--- a/tools/docker/entrypoint.sh
+++ b/tools/docker/entrypoint.sh
@@ -31,6 +31,8 @@  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 not, you need -v PATH_TO_PATCHWORK:/home/patchwork/patchwork"
+    echo "If yes, you may need to create an SELinux rule. Refer to the"
+    echo "development installation documentation for more information."
     exit 1
 fi