summaryrefslogtreecommitdiff
path: root/docs/containers-mounts.conf.5.md
diff options
context:
space:
mode:
authorValentin Rothberg <vrothberg@suse.com>2018-08-30 11:24:06 +0200
committerAtomic Bot <atomic-devel@projectatomic.io>2018-08-30 16:51:56 +0000
commit1243bfa6f14ed6cfb21e7db965e52bb7ddafd1f0 (patch)
tree58b0b1e5341b0617a5d65663aac2663afade7d55 /docs/containers-mounts.conf.5.md
parent3f6426aeec0fae9e6aac7aa5c5c94600c5fe3ff9 (diff)
downloadpodman-1243bfa6f14ed6cfb21e7db965e52bb7ddafd1f0.tar.gz
podman-1243bfa6f14ed6cfb21e7db965e52bb7ddafd1f0.tar.bz2
podman-1243bfa6f14ed6cfb21e7db965e52bb7ddafd1f0.zip
docs: consistent headings
Base heading is level 2, which is identical to the level 1. However level 3 will be indendet which is used a lot in the `## EXAMPLES` sections. Signed-off-by: Valentin Rothberg <vrothberg@suse.com> Closes: #1375 Approved by: rhatdan
Diffstat (limited to 'docs/containers-mounts.conf.5.md')
-rw-r--r--docs/containers-mounts.conf.5.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/containers-mounts.conf.5.md b/docs/containers-mounts.conf.5.md
index 84cb2177d..130c1c523 100644
--- a/docs/containers-mounts.conf.5.md
+++ b/docs/containers-mounts.conf.5.md
@@ -1,15 +1,15 @@
% containers-mounts.conf(5)
-# NAME
+## NAME
containers-mounts.conf - configuration file for default mounts in containers
-# DESCRIPTION
+## 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
+## 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
+## 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