Skip to content

Commit

Permalink
linting
Browse files Browse the repository at this point in the history
  • Loading branch information
luc-ass committed Dec 14, 2024
1 parent 3305688 commit 5c760ab
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ services:

If these labels are not specified, the container will use the global settings from the notifier's environment variables.


### 2.4 Remote docker instance

By default notifier connects to a local docker instance (don't forget to specify `--volume /var/run/docker.sock:/var/run/docker.sock:ro` for this case). But if you have monitoring and the service on the same host, you will not receive notifications if the host goes down. So I recommend to have monitoring separately.
Expand Down Expand Up @@ -194,6 +195,7 @@ services:


### 3.1 Customizing message strings

### 3.1.1 Default docker event variables

Here are some variables available to customize the notification messages.
Expand All @@ -210,6 +212,7 @@ container_start: e =>
`<pre>${e.Actor.Attributes.image}</pre>`,
```


### 3.1.2 Docker Compose variables

The following variables are only available if the container was started using `docker compose`
Expand All @@ -220,14 +223,13 @@ The following variables are only available if the container was started using `d
| `${e.Actor.Attributes['com.docker.compose.service']}` | Compose Service Name |
| `${e.Actor.Attributes['com.docker.compose.version']}` | Compose Version |


### 3.1.3 Custom container information in Telegram notifications

Leverage the `labels:` defintion on docker services to make custom information available to notification messages:

1. __Add custom labels to a container:__



using `docker-compose.yaml`
```yml
services:
Expand Down

0 comments on commit 5c760ab

Please sign in to comment.