Skip to content

Commit 1d1cf3b

Browse files
authored
add docs, bump version (#58)
* add docs, bump version * change doc wording
1 parent bd6aa16 commit 1d1cf3b

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,26 @@ Automatically update your running Docker containers to the latest available imag
1313

1414
A python-based alternative to [watchtower](https://github.com/v2tec/watchtower)
1515

16+
## Table of Contents
17+
18+
- [Overview](#overview)
19+
- [Usage](#usage)
20+
- [Docker](#docker)
21+
- [Pip](#pip)
22+
- [Options](#options)
23+
- [Config File](#config-file)
24+
- [Private Registries](#private-registries)
25+
- [Examples](#examples)
26+
- [Monitor for updates for original tag](#monitor-for-updates-for-original-tag)
27+
- [Update containers on a remote host](#update-containers-on-a-remote-host)
28+
- [Change update frequency](#change-update-frequency)
29+
- [Change loglevel](#change-loglevel)
30+
- [Update all containers and quit ouroboros](#update-all-containers-and-quit-ouroboros)
31+
- [Remove old docker images](#remove-old-docker-images)
32+
- [Prometheus metrics](#prometheus-metrics)
33+
- [Execute Tests](#execute-tests)
34+
- [Contributing](#contributing)
35+
1636
## Overview
1737

1838
Ouroboros will monitor all running docker containers or those you specify and update said containers to the latest available image in the remote registry using the `latest` tag with the same parameters that were used when the container was first created such as volume/bind mounts, docker network connections, environment variables, restart policies, entrypoints, commands, etc. While ouroboros updates images to `latest` by default, that can be [overridden](#Options) to only monitor updates of a specific tag. Similar to [watchtower](https://github.com/v2tec/watchtower).
@@ -107,6 +127,24 @@ docker run --rm circa10a/ouroboros --help
107127
- Default is `8000`.
108128
- Environment variable: `METRICS_PORT=8000`
109129
130+
### Config File
131+
132+
You can provide a [docker env file](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to supplement a config file with all the above listed arguments by utilizing the supported environment variables.
133+
134+
```bash
135+
docker run -d --name ouroboros \
136+
--env-file env.list \
137+
-v /var/run/docker.sock:/var/run/docker.sock \
138+
circa10a/ouroboros
139+
```
140+
141+
**Sample env.list**
142+
143+
```
144+
URL=tcp://localhost:2375
145+
INTERVAL=60
146+
KEEPTAG=true
147+
```
110148
### Private Registries
111149

112150
If your running containers' docker images are stored in a secure registry that requires a username and password, simply run ouroboros with 2 environment variables(`REPO_USER` and `REPO_PASS`).

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def read_reqs(requirements):
1313

1414
setup(
1515
name='ouroboros-cli',
16-
version='0.3.2',
16+
version='0.3.3',
1717
description='Automatically update running docker containers',
1818
long_description=readme(),
1919
long_description_content_type='text/markdown',

0 commit comments

Comments
 (0)