From 079164c39193ee35641e2f4b680d8e69fe553625 Mon Sep 17 00:00:00 2001 From: Morten Linderud Date: Sat, 2 Nov 2019 13:48:47 +0100 Subject: [docs] Ensure we include section 5 documentation Section 5 documentation is missing from the documentation restructure. Signed-off-by: Morten Linderud --- docs/source/markdown/containers-mounts.conf.5.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/source/markdown/containers-mounts.conf.5.md (limited to 'docs/source/markdown/containers-mounts.conf.5.md') diff --git a/docs/source/markdown/containers-mounts.conf.5.md b/docs/source/markdown/containers-mounts.conf.5.md new file mode 100644 index 000000000..130c1c523 --- /dev/null +++ b/docs/source/markdown/containers-mounts.conf.5.md @@ -0,0 +1,16 @@ +% containers-mounts.conf(5) + +## NAME +containers-mounts.conf - configuration file for default mounts in containers + +## DESCRIPTION +The mounts.conf file specifies volume mount directories that are automatically mounted inside containers. Container processes can then use this content. Usually these directories are used for passing secrets or credentials required by the package software to access remote package repositories. Note that for security reasons, tools adhering to the mounts.conf are expected to copy the contents instead of bind mounting the paths from the host. + +## FORMAT +The format of the mounts.conf is the volume format `/SRC:/DEST`, one mount per line. For example, a mounts.conf with the line `/usr/share/secrets:/run/secrets` would cause the contents of the `/usr/share/secrets` directory on the host to be mounted on the `/run/secrets` directory inside the container. Setting mountpoints allows containers to use the files of the host, for instance, to use the host's subscription to some enterprise Linux distribution. + +## FILES +Some distributions may provide a `/usr/share/containers/mounts.conf` file to provide default mounts, but users can create a `/etc/containers/mounts.conf`, to specify their own special volumes to mount in the container. + +## HISTORY +Aug 2018, Originally compiled by Valentin Rothberg -- cgit v1.2.3-54-g00ecf