mirrors/diun
1
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-12-21 21:33:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update doc

Browse Source
This commit is contained in:
CrazyMax
2020-01-28 21:10:15 +01:00
parent d6c18d98de
commit 326be81d90
4 changed files with 20 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -26,9 +26,7 @@
* Worker pool to parallelize analyses * Worker pool to parallelize analyses
* Allow overriding image os and architecture * Allow overriding image os and architecture
* Multi providers available like [Docker](doc/providers/docker.md), [Swarm](doc/providers/swarm.md), [Static](doc/providers/static.md)... * Multi providers available like [Docker](doc/providers/docker.md), [Swarm](doc/providers/swarm.md), [Static](doc/providers/static.md)...
* Beautiful email report * Get notified through Slack, Mail, Telegram and [more](doc/notifications.md)
* Webhook notification
* Slack incoming webhook notification
* Enhanced logging * Enhanced logging
* Timezone can be changed * Timezone can be changed
* Official [Docker image available](doc/install/docker.md) * Official [Docker image available](doc/install/docker.md)

22
doc/configuration.md
View File

@@ -1,5 +1,15 @@
# Configuration # Configuration
* [Overview](#overview)
* [Reference](#reference)
* [db](#db)
* [watch](#watch)
* [notif](#notif)
* [regopts](#regopts)
* [providers](#providers)
## Overview
Here is a YAML structure example: Here is a YAML structure example:
```yml ```yml
@@ -93,17 +103,19 @@ providers:
arch: arm64v8 arch: arm64v8
``` ```
## db ## Reference
### db
* `path`: Path to Bolt database file where images manifests are stored (default: `diun.db`). Environment var `DIUN_DB` override this value. * `path`: Path to Bolt database file where images manifests are stored (default: `diun.db`). Environment var `DIUN_DB` override this value.
## watch ### watch
* `workers`: Maximum number of workers that will execute tasks concurrently. _Optional_. (default: `10`). * `workers`: Maximum number of workers that will execute tasks concurrently. _Optional_. (default: `10`).
* `schedule`: [CRON expression](https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format) to schedule Diun watcher. _Optional_. (default: `0 * * * *`). * `schedule`: [CRON expression](https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format) to schedule Diun watcher. _Optional_. (default: `0 * * * *`).
* `first_check_notif`: Send notification at the very first analysis of an image. _Optional_. (default: `false`). * `first_check_notif`: Send notification at the very first analysis of an image. _Optional_. (default: `false`).
## notif ### notif
* `mail` * `mail`
* `enable`: Enable email reports (default: `false`). * `enable`: Enable email reports (default: `false`).
@@ -134,7 +146,7 @@ providers:
* `headers`: Map of additional headers to be sent. * `headers`: Map of additional headers to be sent.
* `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`). * `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`).
## regopts ### regopts
* `username`: Registry username. * `username`: Registry username.
* `username_file`: Use content of secret file as registry username if `username` not defined. * `username_file`: Use content of secret file as registry username if `username` not defined.
@@ -143,7 +155,7 @@ providers:
* `timeout`: Timeout is the maximum amount of time for the TCP connection to establish. 0 means no timeout (default: `10`). * `timeout`: Timeout is the maximum amount of time for the TCP connection to establish. 0 means no timeout (default: `10`).
* `insecure_tls`: Allow contacting docker registry over HTTP, or HTTPS with failed TLS verification (default: `false`). * `insecure_tls`: Allow contacting docker registry over HTTP, or HTTPS with failed TLS verification (default: `false`).
## providers ### providers
* `docker`: Map of Docker standalone engines to watch * `docker`: Map of Docker standalone engines to watch
* `<key>`: An unique identifier for this provider. * `<key>`: An unique identifier for this provider.

2
doc/providers/docker.md
View File

@@ -6,7 +6,7 @@
## About ## About
The Docker provider allows you to analyze the containers of your standalone Docker instance defined in the [Diun configuration](../configuration.md) to extract the images found and check for updates on the registry. The Docker provider allows you to analyze the containers of your standalone Docker instance defined in the [Diun configuration](../configuration.md#providers) to extract the images found and check for updates on the registry.
## Quick start ## Quick start

2
doc/providers/swarm.md
View File

@@ -6,7 +6,7 @@
## About ## About
The Swarm provider is closely linked to the [Docker provider](docker.md) except that it allows you to analyze the services of your Swarm cluster defined in the [Diun configuration](../configuration.md) to extract the images found and check for updates on the registry. The Swarm provider is closely linked to the [Docker provider](docker.md) except that it allows you to analyze the services of your Swarm cluster defined in the [Diun configuration](../configuration.md#providers) to extract the images found and check for updates on the registry.
## Quick start ## Quick start