Browse code

docs: note requirements for systemd drop-in filenames

the documentations says that you can drop "a file" into the
`docker.service.d` directory, but does not note that the file must end
with `.conf` in order to be recognized by systemd. This can lead to
some [confusion][] if readers are not previously familiar with
systemd.

[confusion]: https://botbot.me/freenode/docker/2016-05-06/?msg=65605541&page=11

Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>

Lars Kellogg-Stedman authored on 2016/05/07 04:52:42
Showing 1 changed files
... ...
@@ -33,15 +33,19 @@ If you want Docker to start at boot, you should also:
33 33
 There are a number of ways to configure the daemon flags and environment variables
34 34
 for your Docker daemon.
35 35
 
36
-The recommended way is to use a systemd drop-in file. These are local files in
37
-the `/etc/systemd/system/docker.service.d` directory. This could also be
38
-`/etc/systemd/system/docker.service`, which also works for overriding the
39
-defaults from `/lib/systemd/system/docker.service`.
40
-
41
-However, if you had previously used a package which had an `EnvironmentFile`
42
-(often pointing to `/etc/sysconfig/docker`) then for backwards compatibility,
43
-you drop a file in the `/etc/systemd/system/docker.service.d`
44
-directory including the following:
36
+The recommended way is to use a systemd drop-in file (as described in
37
+the <a target="_blank"
38
+href="https://www.freedesktop.org/software/systemd/man/systemd.unit.html">systemd.unit</a>
39
+documentation). These are local files named `<something>.conf` in the
40
+`/etc/systemd/system/docker.service.d` directory. This could also be
41
+`/etc/systemd/system/docker.service`, which also works for overriding
42
+the defaults from `/lib/systemd/system/docker.service`.
43
+
44
+However, if you had previously used a package which had an
45
+`EnvironmentFile` (often pointing to `/etc/sysconfig/docker`) then for
46
+backwards compatibility, you drop a file with a `.conf` extension into
47
+the `/etc/systemd/system/docker.service.d` directory including the
48
+following:
45 49
 
46 50
     [Service]
47 51
     EnvironmentFile=-/etc/sysconfig/docker