57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
<img src="/docs/static/img/logo.png" alt="Logo">
|
|
|
|
# Grafana to Ntfy
|
|
|
|
- [Ntfy](https://ntfy.sh/)
|
|
- [Grafana](https://grafana.com/)
|
|
|
|
## Summary
|
|
|
|
- [Example](#example)
|
|
- [Installation](#installation)
|
|
- [Docker compose](#docker-compose)
|
|
- [Variables](#variables)
|
|
- [Grafana configuration](#grafana-configuration)
|
|
|
|
## Example
|
|
|
|
Here is an example of a notification.
|
|
|
|
<img src="/docs/static/img/demo.png" alt="Example of a notification">
|
|
|
|
## Installation
|
|
|
|
### Docker compose
|
|
|
|
```yml
|
|
version: '3.8'
|
|
|
|
services:
|
|
grafana:
|
|
container_name: grafana
|
|
image: grafana/grafana
|
|
restart: always
|
|
ports:
|
|
- '3003:3000'
|
|
|
|
grafana-to-ntfy:
|
|
container_name: grafana-to-ntfy
|
|
image: saibe1111/grafana-to-ntfy
|
|
restart: unless-stopped
|
|
environment:
|
|
NTFY_TOPIC: grafana-custom-alert-topic
|
|
```
|
|
|
|
### Variables
|
|
|
|
| **Variable** | **Usage** | **Default value** | **Required** |
|
|
| :----------: | ---------------------------------------------------------------- | :---------------: | :----------: |
|
|
| NTFY_TOPIC | Topic name | grafana | ❌ |
|
|
| NTFY_SERVER | URL of the ntfy server | https://ntfy.sh | ❌ |
|
|
| NTFY_TOKEN | Access tokens [Docs](https://docs.ntfy.sh/config/#access-tokens) | / | ❌ |
|
|
|
|
## Grafana configuration
|
|
|
|
You just need to add a webhook contact point as below:
|
|
|
|
<img src="/docs/static/img/grafana-config.png" alt="Grafana webhook contact point">
|