mirror of
https://github.com/crazy-max/diun.git
synced 2026-01-02 02:57:28 +01:00
213 lines
9.1 KiB
Markdown
213 lines
9.1 KiB
Markdown
<p align="center"><a href="https://github.com/crazy-max/diun" target="_blank"><img height="128"src="https://raw.githubusercontent.com/crazy-max/diun/master/.res/diun.png"></a></p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/crazy-max/diun/releases/latest"><img src="https://img.shields.io/github/release/crazy-max/diun.svg?style=flat-square" alt="GitHub release"></a>
|
|
<a href="https://github.com/crazy-max/diun/releases/latest"><img src="https://img.shields.io/github/downloads/crazy-max/diun/total.svg?style=flat-square" alt="Total downloads"></a>
|
|
<a href="https://travis-ci.com/crazy-max/diun"><img src="https://img.shields.io/travis/com/crazy-max/diun/master.svg?style=flat-square" alt="Build Status"></a>
|
|
<a href="https://hub.docker.com/r/crazymax/diun/"><img src="https://img.shields.io/badge/dynamic/json.svg?label=docker%20tag&query=$.results[1].name&url=https://hub.docker.com/v2/repositories/crazymax/diun/tags&style=flat-square" alt="Docker Tag"></a>
|
|
<a href="https://hub.docker.com/r/crazymax/diun/"><img src="https://img.shields.io/docker/stars/crazymax/diun.svg?style=flat-square" alt="Docker Stars"></a>
|
|
<a href="https://hub.docker.com/r/crazymax/diun/"><img src="https://img.shields.io/docker/pulls/crazymax/diun.svg?style=flat-square" alt="Docker Pulls"></a>
|
|
<br /><a href="https://quay.io/repository/crazymax/diun"><img src="https://quay.io/repository/crazymax/diun/status?style=flat-square" alt="Docker Repository on Quay"></a>
|
|
<a href="https://goreportcard.com/report/github.com/crazy-max/diun"><img src="https://goreportcard.com/badge/github.com/crazy-max/diun?style=flat-square" alt="Go Report"></a>
|
|
<a href="https://www.codacy.com/app/crazy-max/diun"><img src="https://img.shields.io/codacy/grade/93db381dca8b441cb69b45b75f5e10ed.svg?style=flat-square" alt="Code Quality"></a>
|
|
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=X2NYRW7D9KL4E"><img src="https://img.shields.io/badge/donate-paypal-7057ff.svg?style=flat-square" alt="Donate Paypal"></a>
|
|
</p>
|
|
|
|
## About
|
|
|
|
**Diun** :bell: is a CLI application written in [Go](https://golang.org/) to receive notifications :inbox_tray: when a Docker :whale: image is updated on a Docker registry. With Go, this app can be used across many platforms :game_die: and architectures. This support includes Linux, FreeBSD, macOS and Windows on architectures like amd64, i386, ARM and others.
|
|
|
|
## Features
|
|
|
|
* Allow to watch a full Docker repository and report new tags
|
|
* Include and exclude filters with regular expression for tags
|
|
* Internal cron implementation through go routines
|
|
* Beautiful email report
|
|
* Webhook notification
|
|
* Enhanced logging
|
|
* Timezone can be changed
|
|
* :whale: Official [Docker image available](#docker)
|
|
|
|
## Download
|
|
|
|
Diun binaries are available in [releases](https://github.com/crazy-max/diun/releases) page.
|
|
|
|
Choose the archive matching the destination platform and extract diun:
|
|
|
|
```
|
|
$ cd /opt
|
|
$ wget -qO- https://github.com/crazy-max/diun/releases/download/v0.1.0/diun_0.1.0_linux_x86_64.tar.gz | tar -zxvf - diun
|
|
```
|
|
|
|
After getting the binary, it can be tested with `./diun --help` or moved to a permanent location.
|
|
|
|
```
|
|
$ ./diun --help
|
|
usage: diun --config=CONFIG [<flags>]
|
|
|
|
Docker image update notifier. More info on https://github.com/crazy-max/diun
|
|
|
|
Flags:
|
|
--help Show context-sensitive help (also try --help-long and
|
|
--help-man).
|
|
--config=CONFIG Diun configuration file.
|
|
--timezone="UTC" Timezone assigned to Diun.
|
|
--log-level="info" Set log level.
|
|
--log-json Enable JSON logging output.
|
|
--run-once Run once on startup.
|
|
--docker Enable Docker mode.
|
|
--version Show application version.
|
|
```
|
|
|
|
## Usage
|
|
|
|
`diun --config=CONFIG [<flags>]`
|
|
|
|
* `--help` : Show help text and exit. _Optional_.
|
|
* `--version` : Show version and exit. _Optional_.
|
|
* `--config <path>` : Diun YAML configuration file. **Required**. (example: `diun.yml`).
|
|
* `--timezone <timezone>` : Timezone assigned to Diun. _Optional_. (default: `UTC`).
|
|
* `--log-level <level>` : Log level output. _Optional_. (default: `info`).
|
|
* `--log-json` : Enable JSON logging output. _Optional_. (default: `false`).
|
|
* `--run-once` : Run once on startup. _Optional_. (default: `false`).
|
|
|
|
## Configuration
|
|
|
|
Before running Diun, you must create your first configuration file. Here is a YAML structure example :
|
|
|
|
```yml
|
|
db:
|
|
path: diun.db
|
|
|
|
watch:
|
|
schedule: 0 */30 * * * *
|
|
|
|
notif:
|
|
mail:
|
|
enable: false
|
|
host: localhost
|
|
port: 25
|
|
ssl: false
|
|
insecure_skip_verify: false
|
|
username:
|
|
password:
|
|
from:
|
|
to:
|
|
webhook:
|
|
enable: false
|
|
endpoint: http://webhook.foo.com/sd54qad89azd5a
|
|
method: GET
|
|
headers:
|
|
Content-Type: application/json
|
|
Authorization: Token123456
|
|
timeout: 10
|
|
|
|
reg_creds:
|
|
aregistrycred:
|
|
username: foo
|
|
password: bar
|
|
another:
|
|
username: foo2
|
|
password: bar2
|
|
|
|
items:
|
|
-
|
|
image: docker.io/crazymax/nextcloud:latest
|
|
reg_cred_id: aregistrycred
|
|
-
|
|
image: jfrog-docker-reg2.bintray.io/jfrog/artifactory-oss:4.0.0
|
|
reg_cred_id: another
|
|
-
|
|
image: quay.io/coreos/hyperkube
|
|
-
|
|
image: crazymax/swarm-cronjob
|
|
watch_repo: true
|
|
include_tags:
|
|
- ^1.2.*
|
|
```
|
|
|
|
* `db`
|
|
* `path`: Path to Bolt database file where images analysis are stored. Flag `--docker` force this path to `/data/diun.db` (default: `diun.db`).
|
|
* `watch`
|
|
* `schedule`: [CRON expression](https://godoc.org/github.com/crazy-max/cron#hdr-CRON_Expression_Format) to schedule Diun watcher. _Optional_. (default: `0 */30 * * * *`).
|
|
* `notif`
|
|
* `mail`
|
|
* `enable`: Enable email reports (default: `false`).
|
|
* `host`: SMTP server host (default: `localhost`). **required**
|
|
* `port`: SMTP server port (default: `25`). **required**
|
|
* `ssl`: SSL defines whether an SSL connection is used. Should be false in most cases since the auth mechanism should use STARTTLS (default: `false`).
|
|
* `insecure_skip_verify`: Controls whether a client verifies the server's certificate chain and host name (default: `false`).
|
|
* `username`: SMTP username.
|
|
* `password`: SMTP password.
|
|
* `from`: Sender email address. **required**
|
|
* `to`: Recipient email address. **required**
|
|
* `webhook`
|
|
* `enable`: Enable webhook notification (default: `false`).
|
|
* `endpoint`: URL of the HTTP request. **required**
|
|
* `method`: HTTP method (default: `GET`). **required**
|
|
* `headers`: Map of additional headers to be sent.
|
|
* `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`).
|
|
* `reg_creds`: Map of registry credentials to use with items. Key is the ID and value is a struct with the following fields:
|
|
* `username`: Registry username.
|
|
* `password`: Registry password.
|
|
* `items`: Slice of items to watch with the following fields:
|
|
* `image`: Docker image to watch using `registry/path:tag` format. If registry is omitted, `docker.io` will be used. If tag is omitted, `latest` will be used. **required**
|
|
* `reg_cred_id`: Registry credential ID from `reg_creds` to use.
|
|
* `insecure_tls`: Allow contacting docker registries over HTTP, or HTTPS with failed TLS verification (default: `false`).
|
|
* `watch_repo`: Watch all tags of this `image` repository (default: `false`).
|
|
* `include_tags`: List of regular expressions to include tags. Can be useful if you use `watch_repo`.
|
|
* `exclude_tags`: List of regular expressions to exclude tags. Can be useful if you use `watch_repo`.
|
|
* `timeout`: Timeout is the maximum amount of time for the TCP connection to establish. 0 means no timeout (default: `10`).
|
|
|
|
## Docker
|
|
|
|
Diun provides automatically updated Docker :whale: images within [Docker Hub](https://hub.docker.com/r/crazymax/diun) and [Quay](https://quay.io/repository/crazymax/diun). It is possible to always use the latest stable tag or to use another service that handles updating Docker images.
|
|
|
|
Environment variables can be used within your container :
|
|
|
|
* `TZ` : Timezone assigned
|
|
* `LOG_LEVEL` : Log level output (default `info`)
|
|
* `LOG_JSON`: Enable JSON logging output (default `false`)
|
|
* `RUN_ONCE`: Run once on startup (default `false`)
|
|
|
|
Docker compose is the recommended way to run this image. Copy the content of folder [.res/compose](.res/compose) in `/opt/diun/` on your host for example. Edit the compose and config file with your preferences and run the following commands :
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
docker-compose logs -f
|
|
```
|
|
|
|
Or use the following command :
|
|
|
|
```bash
|
|
$ docker run -d --name diun \
|
|
-e "TZ=Europe/Paris" \
|
|
-e "LOG_LEVEL=info" \
|
|
-e "LOG_JSON=false" \
|
|
-e "RUN_ONCE=false" \
|
|
-v "$(pwd)/data:/data" \
|
|
-v "$(pwd)/diun.yml:/diun.yml:ro" \
|
|
crazymax/diun:latest
|
|
```
|
|
|
|
## Mail notification sample
|
|
|
|
|
|
|
|
## TODO
|
|
|
|
* [ ] Scan Dockerfile
|
|
* [ ] Watch images from Docker daemon
|
|
|
|
## How can I help ?
|
|
|
|
All kinds of contributions are welcome :raised_hands:!<br />
|
|
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:<br />
|
|
But we're not gonna lie to each other, I'd rather you buy me a beer or two :beers:!
|
|
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=X2NYRW7D9KL4E)
|
|
|
|
## License
|
|
|
|
MIT. See `LICENSE` for more details.
|