60
README.md
60
README.md
@@ -5,49 +5,46 @@
|
||||
## ✨ Features
|
||||
|
||||
### 🎯 Smart Client Management
|
||||
- Automatic discovery of AdGuard clients as Home Assistant entities
|
||||
- Add, update, and remove clients directly from Home Assistant
|
||||
- Automatic discovery of AdGuard clients
|
||||
- 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
|
||||
### 🛡️ Service Blocking
|
||||
- Per-client service blocking (YouTube, Netflix, Gaming, etc.)
|
||||
- Emergency unblock capabilities
|
||||
- Advanced automation services
|
||||
|
||||
### 🏠 Home Assistant Integration
|
||||
- Rich entity support: switches, sensors, binary sensors
|
||||
- Automation-friendly services
|
||||
- Real-time DNS and blocking statistics
|
||||
- Real-time DNS 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 1: HACS (Recommended)
|
||||
1. Open HACS > Integrations
|
||||
2. Add custom repository: `https://git.sq4ind.eu/sq4ind/adguard-control-hub`
|
||||
3. Install "AdGuard Control Hub"
|
||||
4. Restart Home Assistant
|
||||
5. Add integration via UI
|
||||
|
||||
### 🛠️ Method 2: Manual Installation
|
||||
1. Download the latest release zip
|
||||
2. Extract `custom_components/adguard_hub` into your Home Assistant config directory
|
||||
### Method 2: Manual
|
||||
1. Download latest release
|
||||
2. Extract to `custom_components/adguard_hub/`
|
||||
3. Restart Home Assistant
|
||||
4. Add integration via UI
|
||||
4. Add via Integrations 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
|
||||
- **Host**: AdGuard Home IP/hostname
|
||||
- **Port**: Default 3000
|
||||
- **Username/Password**: Admin credentials
|
||||
- **SSL**: Enable if using HTTPS
|
||||
|
||||
## 🎬 Example Automation
|
||||
## 🎬 Example
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: "Kids Bedtime - Block Entertainment"
|
||||
- alias: "Kids Bedtime"
|
||||
trigger:
|
||||
platform: time
|
||||
at: "20:00:00"
|
||||
@@ -55,13 +52,8 @@ automation:
|
||||
service: adguard_hub.block_services
|
||||
data:
|
||||
client_name: "Kids iPad"
|
||||
services:
|
||||
- youtube
|
||||
- netflix
|
||||
- gaming
|
||||
services: ["youtube", "gaming"]
|
||||
```
|
||||
|
||||
## 📄 License
|
||||
This project is licensed under the MIT License.
|
||||
|
||||
Made with ❤️ for Home Assistant and AdGuard Home users!
|
||||
MIT License - Made with ❤️ for Home Assistant users!
|
Reference in New Issue
Block a user