📝 Add README
This commit is contained in:
parent
00c45290fb
commit
fbd096e875
1 changed files with 35 additions and 1 deletions
34
README.md
34
README.md
|
@ -1 +1,35 @@
|
||||||
# Grafana to Ntfy
|
# Grafana to Ntfy
|
||||||
|
|
||||||
|
## 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:dev
|
||||||
|
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 | ❌ |
|
||||||
|
|
||||||
|
## Grafana configuration
|
||||||
|
|
||||||
|
Coming soon...
|
||||||
|
|
Loading…
Reference in a new issue