Files
uptimekuma-snmp-bridge/README.md
Markus F.J. Busche fb23c5f327 Update README
2024-02-03 12:30:38 +01:00

34 lines
978 B
Markdown

# Uptime-Kuma SNMP bridge for QNAP Disk Helth Checks
Checks (QNAP-) disk status by *snmpwalk* and returns HTML output and status code for [Uptime Kuma](https://github.com/louislam/uptime-kuma).
## Docker Run
`docker run -d -p 8684:8684 elpatron68/uptimekuma-snmp-bridge`
## Supported Checks
| Name | OID | Path |
| -- |-- |-- |
| S.M.A.R.T | `.1.3.6.1.4.1.24681.1.2.11.1.7` | `/check-qnap-disk-smart` |
| Disk Status | `.1.3.6.1.4.1.24681.1.2.11.1.4` | `/check-qnap-status` |
| Volume Status | `.1.3.6.1.4.1.24681.1.2.17.1.6.1` | `/check-volume-status` |
## Uptime-Kuma
Add a *HTTP(s) - Keyword* check in Uptime-Kuma with URL
`http://<host-ip of Uptime-Kuma SNMP bridge>:<Port>/check-qnap-status?ip=<IP of your QNAP NAS>`
Keyword: `Healthy: True`
## Docker
Login: `docker login`
Build: `docker build -t uptimekuma-snmp-bridge .`
Tag: `docker tag uptimekuma-snmp-bridge elpatron68/uptimekuma-snmp-bridge`
Push: `docker image push elpatron68/uptimekuma-snmp-bridge`