Files
adguard-control-hub/README.md
Rafal Zielinski e0edf6f865
Some checks failed
🧪 Integration Testing / 🔧 Test Integration (2025.9.4, 3.13) (push) Failing after 19s
🛡️ Code Quality & Security Check / 🔍 Code Quality Analysis (push) Failing after 19s
fix: fixes
Signed-off-by: Rafal Zielinski <sq4ind@gmail.com>
2025-09-28 15:46:21 +01:00

67 lines
2.0 KiB
Markdown

# 🛡️ AdGuard Control Hub
**The ultimate Home Assistant integration for AdGuard Home**
## ✨ Features
### 🎯 Smart Client Management
- Automatic discovery of AdGuard clients as Home Assistant entities
- Add, update, and remove clients directly from Home Assistant
- Per-client protection controls
### 🛡️ Granular Service Blocking
- Per-client service blocking for YouTube, Netflix, Gaming, Social Media, etc.
- Emergency unblock for temporary internet access
- Real-time blocking statistics
### 🏠 Home Assistant Integration
- Rich entity support: switches, sensors, binary sensors
- Automation-friendly services
- Real-time DNS and blocking statistics
## 📦 Installation
### 🔧 Method 1: HACS (Recommended)
1. Open Home Assistant and go to **HACS > Integrations**
2. Click menu (⋮) → **Custom repositories**
3. Add repository URL: `https://git.sq4ind.eu/sq4ind/adguard-control-hub`
4. Set category to **Integration**, click **Add**
5. Search for **AdGuard Control Hub**
6. Click **Install**, then restart Home Assistant
7. Go to **Settings > Devices & Services > Add Integration**
8. Search and select **AdGuard Control Hub**, enter your AdGuard Home details
### 🛠️ Method 2: Manual Installation
1. Download the latest release zip
2. Extract `custom_components/adguard_hub` into your Home Assistant config directory
3. Restart Home Assistant
4. Add integration via UI
## ⚙️ Configuration
- **Host**: IP or hostname of your AdGuard Home
- **Port**: Default 3000 unless customized
- **Username & Password**: Admin credentials for AdGuard Home
- **SSL**: Enable if AdGuard Home runs HTTPS
## 🎬 Example Automation
```yaml
automation:
- alias: "Kids Bedtime - Block Entertainment"
trigger:
platform: time
at: "20:00:00"
action:
service: adguard_hub.block_services
data:
client_name: "Kids iPad"
services:
- youtube
- netflix
- gaming
```
## 📄 License
This project is licensed under the MIT License.
Made with ❤️ for Home Assistant and AdGuard Home users!