From 748ed779a56d32222d602d9bd9de97630d074fb3 Mon Sep 17 00:00:00 2001 From: Lucas Gasenzer Date: Fri, 13 Dec 2024 09:39:12 +0100 Subject: [PATCH] message strings as table --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b7fc8b7..0012ee7 100644 --- a/README.md +++ b/README.md @@ -96,20 +96,24 @@ If you encounter any issues, please feel free to contribute by fixing them and o Here are some variables available to customize the notification messages: -* `${e.Actor.Attributes.name}` = Docker container Name -* `${e.Actor.Attributes.container}` = Docker container ID -* `${e.Actor.Attributes.docker.network.internal}` = Docker Network Internal -* `${e.Actor.Attributes.healthcheck.status}` = Docker container Healthcheck Status -* `${e.Actor.Attributes.image}` = Docker container Image used -* `${e.Actor.Attributes.maintainer}` = Docker container Maintainer -* `${e.Actor.Attributes.signal}` = Docker container Exit Signal -* `${e.Actor.Attributes.exitCode` = Docker container Exit Code - -\+ These are only available if the container was started using `docker-compose.yaml` -* `${e.Actor.Attributes.com.docker.compose.project}` = Compose Project Name -* `${e.Actor.Attributes.com.docker.compose.service}` = Compose Service Name -* `${e.Actor.Attributes.com.docker.compose.version}` = Compose Version -* `${e.Actor.Attributes.com.docker.compose.container-number}` = Compose container Number +| Variable | Description | +| -------- | ----------- | +| `${e.Actor.Attributes.name}` | Docker container Name | +| `${e.Actor.Attributes.container}` | Docker container ID | +| `${e.Actor.Attributes.docker.network.internal}` | Docker Network Internal | +| `${e.Actor.Attributes.healthcheck.status}` | Docker container Healthcheck Status | +| `${e.Actor.Attributes.image}` | Docker container Image used | +| `${e.Actor.Attributes.maintainer}` | Docker container Maintainer | +| `${e.Actor.Attributes.signal}` | Docker container Exit Signal | +| `${e.Actor.Attributes.exitCode` | Docker container Exit Code | + +The following are only available if the container was started using `docker-compose.yaml` +| Variable | Description | +| -------- | ----------- | +| `${e.Actor.Attributes.com.docker.compose.project}` | Compose Project Name | +| `${e.Actor.Attributes.com.docker.compose.service}` | Compose Service Name | +| `${e.Actor.Attributes.com.docker.compose.version}` | Compose Version | +| `${e.Actor.Attributes.com.docker.compose.container-number}` | Compose container Number | ## Blacklist and Whitelist