diff mbox

[3/4] docs: Document SELinux issues

Message ID BLU436-SMTP698C1154E7D51E6B1F4790A3E90@phx.gbl
State Superseded
Headers show

Commit Message

Stephen Finucane Aug. 21, 2016, 3:15 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

Daniel Axtens Aug. 28, 2016, 4:15 a.m. UTC | #1
Stephen Finucane <stephenfinucane@hotmail.com> writes:

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

Sorry to hear that! Thanks for documenting this - I'll have to start
testing with Fedora at some point.

Regards,
Daniel

>
> Signed-off-by: Stephen Finucane <stephenfinucane@hotmail.com>
> ---
>  docs/development.md        | 16 ++++++++++++++++
>  tools/docker/entrypoint.sh |  2 ++
>  2 files changed, 18 insertions(+)
>
> diff --git a/docs/development.md b/docs/development.md
> index eaf3182..60ea904 100644
> --- a/docs/development.md
> +++ b/docs/development.md
> @@ -54,6 +54,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 bad507d..cd8ccf3 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
>  
> -- 
> 2.7.4
>
> _______________________________________________
> Patchwork mailing list
> Patchwork@lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/patchwork
Stephen Finucane Aug. 29, 2016, 11:25 p.m. UTC | #2
On 28 Aug 14:15, Daniel Axtens wrote:
> Stephen Finucane <stephenfinucane@hotmail.com> writes:
> 
> > Initial Docker setup caused me some heartache on Fedora. Briefly
> > document the issues encountered to help other users.
> 
> Sorry to hear that! Thanks for documenting this - I'll have to start
> testing with Fedora at some point.
> 
> Regards,
> Daniel

No problem: it's Docker's issue, not yours. You happy with this
otherwise?

Stephen
Daniel Axtens Aug. 30, 2016, 12:51 a.m. UTC | #3
Stephen Finucane <stephenfinucane@hotmail.com> writes:

> On 28 Aug 14:15, Daniel Axtens wrote:
>> Stephen Finucane <stephenfinucane@hotmail.com> writes:
>> 
>> > Initial Docker setup caused me some heartache on Fedora. Briefly
>> > document the issues encountered to help other users.
>> 
>> Sorry to hear that! Thanks for documenting this - I'll have to start
>> testing with Fedora at some point.
>> 
>> Regards,
>> Daniel
>
> No problem: it's Docker's issue, not yours. You happy with this
> otherwise?

Yes - sorry, should have made that clearer initially.

Daniel

>
> Stephen
diff mbox

Patch

diff --git a/docs/development.md b/docs/development.md
index eaf3182..60ea904 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -54,6 +54,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 bad507d..cd8ccf3 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