Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update docs #34

Merged
merged 5 commits into from
Oct 26, 2018
Merged

update docs #34

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
84586f2
update docs
Oct 26, 2018
80d0efc
change formatting
Oct 26, 2018
b7b2507
change formatting
Oct 26, 2018
a3027a5
remove extra note
Oct 26, 2018
22ab446
remove extra note
Oct 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,22 +46,34 @@ services:
command: --interval 60 --loglevel debug
```

> By default, running containers will be polled every 5 min

### Options

> All arguments can be ran together without conflication

> All arguments can be supplemented with environment variables, but command line arguments will take priority

```
docker run --rm circa10a/ouroboros --help
```

- `--url`, `-u` Monitor and update containers on a remote system by providing the `url` argument. Default is `unix://var/run/docker.sock`
- `--interval`, `-i` Change how often ouroboros checks the remote docker registry for image updates (in seconds). Default is `300`
- `--monitor`, `-m` Only monitor select containers which supports an infinite amount of container names. Default is all containers.
- `--loglevel`, `-l` The amount of logging details can be supressed or increased Default is `info`.
- `--runonce`, `-r` Update all your running containers in one go and terminate ouroboros. Default is `False`.
- `--cleanup`, `-c` Remove the older docker image if a new one is found and updated. Default is `False`.
- `--url`, `-u` Monitor and update containers on a remote system by providing the `url` argument.
- Default is `unix://var/run/docker.sock`.
- Environment variable: `URL=tcp://localhost:2375`.
- `--interval`, `-i` Change how often ouroboros checks the remote docker registry for image updates (in seconds).
- Default is `300`.
- Environment variable: `INTERVAL=60`.
- `--monitor`, `-m` Only monitor select containers which supports an infinite amount of container names.
- Default is all containers.
- Environment variable: `MONITOR=test_container`
- `--loglevel`, `-l` The amount of logging details can be supressed or increased.
- Default is `info`.
- Environment variable: `LOGLEVEL=debug`.
- `--runonce`, `-r` Update all your running containers in one go and terminate ouroboros.
- Default is `False`.
- Environment variable: `RUNONCE=true`.
- `--cleanup`, `-c` Remove the older docker image if a new one is found and updated.
- Default is `False`.
- Environment variable: `CLEANUP=true`

### Private Registries

Expand Down