archive/crazy-max_diun
0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-04-11 06:01:21 +00:00
Code Issues Projects Releases Wiki Activity

Small changes in doc

Browse source
This commit is contained in:
CrazyMax 2020-06-23 00:58:18 +02:00
parent 9497af491f
commit 9969ec7b9b
No known key found for this signature in database
GPG key ID: 3248E46B6BB8C7F7
5 changed files with 5 additions and 4 deletions

1
docs/notif/script.md
View file

@ -5,6 +5,7 @@ You can call a script when a notification occured. Following environment variabl
```
DIUN_VERSION=3.0.0
DIUN_ENTRY_STATUS=new
DIUN_ENTRY_HOSTNAME=myserver
DIUN_ENTRY_PROVIDER=file
DIUN_ENTRY_IMAGE=docker.io/crazymax/diun:latest
DIUN_ENTRY_HUBLINK=https://hub.docker.com/r/crazymax/diun

2
docs/providers/docker.md
View file

@ -170,7 +170,7 @@ You can configure more finely the way to analyze the image of your container thr
| Name | Default | Description |
|-------------------------------|---------------|---------------|
| `diun.enable` | | Set to true to enable image analysis of this container |
| `diun.regopt` | | Registry options name from [`regopts`](../config/regopts.md) to use |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this container image |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semi-colon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |

2
docs/providers/file.md
View file

@ -172,7 +172,7 @@ The configuration file(s) defines a slice of images to analyze with the followin
| Name | Default | Description |
|-------------------------------|----------------------------------|---------------|
| `name` | `latest` | Docker image name to watch using `registry/path:tag` format. If registry omitted, `docker.io` will be used and if tag omitted, `latest` will be used |
| `regopt` | | Registry options name from [`regopts`](../config/regopts.md) to use |
| `regopt` | | [Registry options](../config/regopts.md) name to use |
| `watch_repo` | `false` | Watch all tags of this image |
| `max_tags` | `0` | Maximum number of tags to watch if `watch_repo` enabled. `0` means all of them |
| `include_tags` | | List of regular expressions to include tags. Can be useful if you enable `watch_repo` |

2
docs/providers/kubernetes.md
View file

@ -273,7 +273,7 @@ You can configure more finely the way to analyze the image of your pods through
| Name | Default | Description |
|-------------------------------|---------------|---------------|
| `diun.enable` | | Set to true to enable image analysis of this pod |
| `diun.regopt` | | Registry options name from [`regopts`](../config/regopts.md) to use |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this pod image |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semi-colon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |

2
docs/providers/swarm.md
View file

@ -174,7 +174,7 @@ You can configure more finely the way to analyze the image of your service throu
| Name | Default | Description |
|-------------------------------|---------------|---------------|
| `diun.enable` | | Set to true to enable image analysis of this service |
| `diun.regopt` | | Registry options name to use from [`regopts`](../config/regopts.md) to use |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this service image |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semi-colon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |