Skip to content

Commit

Permalink
docs: Adds an example config to README.md
Browse files Browse the repository at this point in the history
Closes #1
  • Loading branch information
andyquinterom committed Oct 16, 2024
1 parent 058e29d commit 54493a0
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ versions of images to deploying seemlessly.

Dispenser works as a daemon that runs in the background of the host server.

## Example config

This is an example config that you can base yours around. This config
listens to changes on the `nginx:latest` image and reloads the
docker compose found in the directory `/opt/dispenser/example`.

```toml
delay=60 # Will watch for updates every 60 seconds

[[instance]]
path = "example"
images = [
{ registry = "docker.io", name = "nginx", tag = "latest" }
]
```

## Build

### RPM (RHEL)
Expand Down

0 comments on commit 54493a0

Please sign in to comment.