Skip to content

Commit d1043ec

Browse files
author
Marek Suchánek
committed
Warn about known issues of the container
1 parent 8d905ab commit d1043ec

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

docs/using-newdoc.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,15 @@ $ brew install msuchane/repo/newdoc
6969

7070
To install `newdoc` as a container, use Docker or Podman.
7171

72+
[WARNING]
73+
--
74+
The `newdoc` container needs to access files in your host file system. It mounts your current directory into the container.
75+
76+
When the container runs, it relabels the SELinux configuration on all files in your current directory. This is necessary in order for the SELinux permissions system to enable file access on Fedora, RHEL, and CentOS.
77+
78+
As a consequence, you cannot run the `newdoc` container in certain directories specially protected by SELinux, such as at the root of your home directory.
79+
--
80+
7281
On Fedora, RHEL, and CentOS, replace `docker` with `podman` in the following commands:
7382

7483
. Download the image:
@@ -85,10 +94,10 @@ alias newdoc="podman run -it -v .:/mnt/newdoc:Z msuchane/newdoc newdoc"
8594

8695
. Open a new terminal to reload the shell configuration.
8796

88-
. Test that `newdoc` works:
97+
. Test that `newdoc` works in a documentation directory:
8998
+
9099
----
91-
$ newdoc
100+
documentation-directory]$ newdoc
92101
----
93102

94103
=== From source on any platform

0 commit comments

Comments
 (0)