wifi-prometheus-exporter/README.md
2025-06-02 21:44:50 +02:00

20 lines
656 B
Markdown

# wifi-prometheus-exporter
Export list of mac addresses connected to wifi.
Connects to the router or access point over ssh and export the connected wifi
clients as prometheus metrics and ( optionally) MQTT for home assistant.
## Requirements
A router or access point that can be accessed over ssh and uses iwd.
Tested with OpenWrt
## Usage
- Create a config file as shown in the [example](./config.sample.toml)
- Run `wifi-prometheus-exporter <path to config>`
- Scrape the exported metrics on the configured port at `/metrics`
- If MQTT is in use and home assistant is setup with MQTT integration, the wifi
clients should be automatically added.