space/adguard-monitor
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md with Docker setup instructions and clarify environment variables

Browse Source
This commit is contained in:
Space-Banane
2026-03-12 16:14:23 +01:00
parent 88c3508f92
commit 2f1bddbc11
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -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). - **Custom Domain Monitoring**: Monitor specific domains using [list.txt](list.txt) (wildcards supported).
- **Structured Logging**: UTF-8 encoded logging for unicode emoji support. - **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.** 1. **Clone the repository.**
2. **Install dependencies**: 2. **Install dependencies**:
@@ -40,9 +50,12 @@ Adguard Monitor is designed for openclaw, which should usually NEVER make a requ
## Environment Variables ## Environment Variables
- `ADGUARD_URL`: Full URL of your AdGuard instance (e.g., `http://192.168.1.50`). - `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. - `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_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}"`. - `HASS_MSG_TEMPLATE`: (Optional) Template for notification body. Available: same as title. Default: `{client_name} tried to access "{host}"`.