From 2f1bddbc11157d1529802f67e689724216a5d2b3 Mon Sep 17 00:00:00 2001 From: Space-Banane Date: Thu, 12 Mar 2026 16:14:23 +0100 Subject: [PATCH] Update README.md with Docker setup instructions and clarify environment variables --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aa595f0..879e953 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,17 @@ Adguard Monitor is designed for openclaw, which should usually NEVER make a requ - **Custom Domain Monitoring**: Monitor specific domains using [list.txt](list.txt) (wildcards supported). - **Structured Logging**: UTF-8 encoded logging for unicode emoji support. -## Setup +### Docker (Recommended) +You can run the monitor as a Docker container using the provided `docker-compose.yml`. + +1. **Configure environment**: + Copy `.env.example` to `.env` and fill in your details. +2. **Start the container**: + ```bash + docker compose up -d + ``` + +### Manual Setup 1. **Clone the repository.** 2. **Install dependencies**: @@ -40,9 +50,12 @@ Adguard Monitor is designed for openclaw, which should usually NEVER make a requ ## Environment Variables - `ADGUARD_URL`: Full URL of your AdGuard instance (e.g., `http://192.168.1.50`). -- `ADGUARD_USER/PASSWORD`: API credentials. +- `ADGUARD_USER`: API username. +- `ADGUARD_PASSWORD`: API password. - `CLIENTS`: A JSON-formatted dictionary mapping IPs to display names. -- `HASS_URL/TOKEN`: Home Assistant mobile notification endpoint and Long-Lived Access Token. + - Example: `{"192.168.1.100": "My Laptop", "192.168.1.101": "My Phone"}` +- `HASS_URL`: Home Assistant mobile notification endpoint (e.g. `https://your-hass.com/api/services/notify/mobile_app_phone`). +- `HASS_TOKEN`: Home Assistant Long-Lived Access Token. - `HASS_TITLE_TEMPLATE`: (Optional) Template for notification title. Available: `{event_type}`, `{client_name}`, `{host}`, `{reason}`. Default: `{event_type}`. - `HASS_MSG_TEMPLATE`: (Optional) Template for notification body. Available: same as title. Default: `{client_name} tried to access "{host}"`.