Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
dehydr8 committed Jan 22, 2024
1 parent 756f42e commit 4cef4e1
Showing 1 changed file with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,32 @@ make build-cli-arm

## Usage
```
Usage of kasa-exporter:
-address string
address to listen on
-password string
password for kasa login
-port int
port to listen on (default 9500)
-username string
username for kasa login
NAME
kasa-exporter (rev 756f42e)
FLAGS
-l, --log STRING log level: debug, info, warn, error (default: info)
-a, --address STRING address to listen on
-p, --port INT port to listen on (default: 9500)
--username STRING username for kasa login
--password STRING password for kasa login
--hashed_password STRING hashed (sha1) password for kasa login
--max_registries INT maximum number of registries to cache (default: 16)
```

The configuration can also be passed to the program using environment variables prefixed with `KASA_EXPORTER_`.

An example docker compose file would look like:

```yaml
services:
kasa:
image: okhalid/kasa-exporter:latest
environment:
- KASA_EXPORTER_USERNAME=your_tplink_email
- KASA_EXPORTER_HASHED_PASSWORD=your_sha1_hashed_password
ports:
- 9500:9500
```
## Prometheus Config
Expand Down

0 comments on commit 4cef4e1

Please sign in to comment.