Skip to content

Commit 1025460

Browse files
committed
Update the README
* document `state=absent` * document `links` * fix typos and formating errors
1 parent 022b69f commit 1025460

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,15 @@ This will create:
3838
* `env` - key/value pairs of ENV vars that need to be present
3939
* `volumes` (default: _[]_) - List of `-v` arguments
4040
* `ports` (default: _[]_) - List of `-p` arguments
41+
* `link` (default: _[]_) - List of `--link` arguments
4142
* `labels` (default: _[]_) - List of `-l` arguments
4243

4344
#### Systemd service specifics
4445

4546
* `enabled` (default: _yes_) - whether the service should be enabled
4647
* `masked` (default: _no_) - whether the service should be masked
47-
* `state` (default: _started_) - state the service should be in
48+
* `state` (default: _started_) - state the service should be in - set to
49+
`absent` to remove the service.
4850

4951
## Installation
5052

@@ -54,7 +56,13 @@ Put this in your `requirements.yml`:
5456
- role: mhutter.docker-systemd-service
5557
```
5658

57-
and run `ansible-galaxy install -r requirements.yml
59+
and run `ansible-galaxy install -r requirements.yml`.
60+
61+
62+
## Gotchas
63+
64+
* When the unit or env file is changed, systemd gets reloaded but existing
65+
containers are NOT restarted.
5866

5967
## About orchestrating Docker containers using systemd.
6068

0 commit comments

Comments
 (0)