archive/crazy-max_diun
0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-04-12 22:48:08 +00:00
Code Issues Projects Releases Wiki Activity

docs: Fix markdown tables syntax

Browse source
This commit is contained in:
CrazyMax 2022-12-29 07:52:05 +01:00
parent d7909f0156
commit f5ec2d535b
No known key found for this signature in database
GPG key ID: 3248E46B6BB8C7F7
21 changed files with 194 additions and 194 deletions

4
docs/install/docker.md
View file

@ -5,7 +5,7 @@
Diun provides automatically updated Docker :whale: images within several registries:
| Registry | Image |
|--------------------------------------------------------------------------------------------------|---------------------------------|
|-------------------------------------------------------------------------------------------------|--------------------------|
| [Docker Hub](https://hub.docker.com/r/crazymax/diun/) | `crazymax/diun` |
| [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/diun) | `ghcr.io/crazy-max/diun` |
@ -29,7 +29,7 @@ Image: crazymax/diun:latest
## Volumes
| Path | Description |
|--------------------|---------------|
|---------|---------------------------------------------------------------|
| `/data` | Contains bbolt database which retains Docker images manifests |
## Usage

2
docs/notif/amqp.md
View file

@ -16,7 +16,7 @@ You can send notifications to any amqp compatible server with the following sett
```
| Name | Default | Description |
|--------------------|---------------|---------------|
|----------------|-------------|-----------------------------------------------------------------------|
| `host`[^1] | `localhost` | AMQP server host |
| `port`[^1] | `5672` | AMQP server port |
| `username` | | AMQP username |

2
docs/notif/discord.md
View file

@ -22,7 +22,7 @@ Allow sending notifications to your Discord channel.
```
| Name | Default | Description |
|---------------------|---------------------------------------|---------------|
|--------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
| `mentions` | | List of users or roles to notify |
| `renderFields` | `true` | Render [field objects](https://discordjs.guide/popular-topics/embeds.html) |

2
docs/notif/gotify.md
View file

@ -18,7 +18,7 @@ Notifications can be sent using a [Gotify](https://gotify.net/) instance.
```
| Name | Default | Description |
|---------------------|---------------------------------------|---------------|
|---------------------|-------------------------------------|----------------------------------------------------------------------------|
| `endpoint`[^1] | | Gotify base URL |
| `token` | | Application token |
| `tokenFile` | | Use content of secret file as application token if `token` not defined |

2
docs/notif/mail.md
View file

@ -22,7 +22,7 @@ Notifications can be sent through SMTP.
```
| Name | Default | Description |
|-----------------------|--------------------------------------------|---------------|
|----------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `host`[^1] | `localhost` | SMTP server host |
| `port`[^1] | `25` | SMTP server port |
| `ssl` | `false` | SSL defines whether an SSL connection is used. Should be false in most cases since the auth mechanism should use STARTTLS |

2
docs/notif/matrix.md
View file

@ -18,7 +18,7 @@ Allow sending notifications to your Matrix server.
```
| Name | Default | Description |
|-----------------------|--------------------------------------------|-------------------|
|--------------------|------------------------------------|---------------------------------------------------------------------------------|
| `homeserverURL` | `https://matrix.org` | Matrix server URL |
| `user` | | Username for authentication |
| `userFile` | | Use content of secret file as username authentication if `username` not defined |

2
docs/notif/mqtt.md
View file

@ -19,7 +19,7 @@ You can send notifications to any MQTT compatible server with the following sett
```
| Name | Default | Description |
|--------------------|---------------|---------------|
|----------------|-------------|------------------------------------------------------------------------|
| `scheme`[^1] | `mqtt` | MQTT server scheme (`mqtt`, `mqtts`, `ws` or `wss`) |
| `host`[^1] | `localhost` | MQTT server host |
| `port`[^1] | `1883` | MQTT server port |

2
docs/notif/pushover.md
View file

@ -16,7 +16,7 @@ You can send notifications using [Pushover](https://pushover.net/).
```
| Name | Default | Description |
|---------------------|--------------------------------------------|---------------|
|---------------------|-------------------------------------|-------------------------------------------------------------------------------------|
| `token` | | Pushover [application/API token](https://pushover.net/api#registration) |
| `tokenFile` | | Use content of secret file as Pushover application/API token if `token` not defined |
| `recipient` | | User key to send notification to |

2
docs/notif/rocketchat.md
View file

@ -20,7 +20,7 @@ Allow sending notifications to your Rocket.Chat channel.
```
| Name | Default | Description |
|---------------------|--------------------------------------------|---------------|
|---------------------|-------------------------------------|----------------------------------------------------------------------------------------------------|
| `endpoint`[^1] | | Rocket.Chat base URL |
| `channel`[^1] | | Channel name with the prefix in front of it |
| `userID`[^1] | | User ID |

2
docs/notif/script.md
View file

@ -28,7 +28,7 @@ DIUN_ENTRY_PLATFORM=linux/amd64
```
| Name | Default | Description |
|-----------------------|---------------|---------------|
|-----------|---------|------------------------------------------------|
| `cmd`[^1] | | Command or script to execute |
| `args` | | List of args to pass to `cmd` |
| `dir` | | Specifies the working directory of the command |

2
docs/notif/slack.md
View file

@ -18,7 +18,7 @@ You can send notifications to your Slack channel using an [incoming webhook URL]
```
| Name | Default | Description |
|--------------------|--------------------------------------------|---------------|
|--------------------|------------------------------------|-------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) |
| `renderFields` | `true` | Render [field objects](https://api.slack.com/messaging/composing/layouts#stack_of_blocks) |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |

2
docs/notif/teams.md
View file

@ -15,7 +15,7 @@ You can send notifications to your Teams team-channel using an [incoming webhook
```
| Name | Default | Description |
|--------------------|--------------------------------------------|---------------|
|--------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Teams [incoming webhook URL](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/what-are-webhooks-and-connectors) |
| `renderFacts` | `true` | Render fact objects |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |

2
docs/notif/telegram.md
View file

@ -22,7 +22,7 @@ Multiple chat IDs can be provided in order to deliver notifications to multiple
```
| Name | Default | Description |
|--------------------|--------------------------------------------|---------------|
|--------------------|------------------------------------|---------------------------------------------------------------------------|
| `token` | | Telegram bot token |
| `tokenFile` | | Use content of secret file as Telegram bot token if `token` not defined |
| `chatIDs` | | List of chat IDs to send notifications to |

2
docs/notif/webhook.md
View file

@ -17,7 +17,7 @@ You can send webhook notifications with the following settings.
```
| Name | Default | Description |
|--------------------|---------------|---------------|
|----------------|---------|----------------------------------------------------------------|
| `endpoint`[^1] | | URL of the HTTP request |
| `method`[^1] | `GET` | HTTP method |
| `headers` | | Map of additional headers to be sent (key is case insensitive) |

2
docs/providers/docker.md
View file

@ -174,7 +174,7 @@ Include created and exited containers too (default `false`).
You can configure more finely the way to analyze the image of your container through Docker labels:
| Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this container |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this container image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |

2
docs/providers/dockerfile.md
View file

@ -107,7 +107,7 @@ List of path patterns with [matching and globbing supporting patterns](https://g
The following annotations can be added as comments before the target instruction to customize the image analysis:
| Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this image |
| `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` |

2
docs/providers/file.md
View file

@ -173,7 +173,7 @@ Defines the path to the directory that contains the [configuration files](#yaml-
The configuration file(s) defines a slice of images to analyze with the following fields:
| 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](../config/regopts.md) name to use |
| `watch_repo` | `false` | Watch all tags of this image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |

2
docs/providers/kubernetes.md
View file

@ -283,7 +283,7 @@ Enable watch by default. If false, pods that don't have `diun.enable: "true"` an
You can configure more finely the way to analyze the image of your pods through Kubernetes annotations:
| Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this pod |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this pod image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |

2
docs/providers/nomad.md
View file

@ -198,7 +198,7 @@ Enable watch by default. If false, tasks that don't have `diun.enable = true` in
You can configure more finely the way to analyze the image of your tasks through Nomad meta attributes or service tags:
| Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this task |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this task image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |

2
docs/providers/swarm.md
View file

@ -176,7 +176,7 @@ Enable watch by default. If false, services that don't have `diun.enable=true` l
You can configure more finely the way to analyze the image of your service through Docker labels:
| Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this service |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this service image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |

2
docs/usage/command-line.md
View file

@ -37,7 +37,7 @@ diun serve --config diun.yml --log-level debug
Following environment variables can also be used in place:
| Name | Default | Description |
|--------------------|---------------|---------------|
|------------------|----------|----------------------------------------------------------------------|
| `CONFIG` | | Diun configuration file |
| `PROFILER_PATH` | | Base path where profiling files are written |
| `PROFILER` | | [Profiler](../faq.md#profiling) to use |