89
README.md
89
README.md
@@ -7,18 +7,16 @@
|
||||
### 🎯 Smart Client Management
|
||||
- Automatic discovery of AdGuard clients as Home Assistant entities
|
||||
- Add, update, and remove clients directly from Home Assistant
|
||||
- Bulk operations to manage multiple clients simultaneously with pattern matching
|
||||
- Per-client protection controls
|
||||
|
||||
### 🛡️ Granular Service Blocking
|
||||
- Per-client service blocking for YouTube, Netflix, Gaming, Social Media, etc.
|
||||
- Time-based scheduled blocking with per-day rules
|
||||
- Global and per-client toggles for protection
|
||||
- Emergency unblock for temporary internet access
|
||||
- Real-time blocking statistics
|
||||
|
||||
### 🏠 Home Assistant Ecosystem Integration
|
||||
### 🏠 Home Assistant Integration
|
||||
- Rich entity support: switches, sensors, binary sensors
|
||||
- Beautiful and customizable Lovelace dashboard cards
|
||||
- Automation-friendly services for advanced workflows
|
||||
- Automation-friendly services
|
||||
- Real-time DNS and blocking statistics
|
||||
|
||||
## 📦 Installation
|
||||
@@ -34,21 +32,19 @@
|
||||
8. Search and select **AdGuard Control Hub**, enter your AdGuard Home details
|
||||
|
||||
### 🛠️ Method 2: Manual Installation
|
||||
1. Download the latest release zip from your Gitea repository
|
||||
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 as per above
|
||||
4. Add integration via UI
|
||||
|
||||
## ⚙️ Configuration
|
||||
- **Host**: IP or hostname of your AdGuard Home
|
||||
- **Port**: Default 3000 unless customized
|
||||
- **Port**: Default 3000 unless customized
|
||||
- **Username & Password**: Admin credentials for AdGuard Home
|
||||
- **SSL**: Enable if AdGuard Home runs HTTPS
|
||||
- **Verify SSL**: Disable for self-signed certificates
|
||||
|
||||
## 🎬 Use Cases & Examples
|
||||
## 🎬 Example Automation
|
||||
|
||||
### Parental Controls - Kids Bedtime Automation
|
||||
```yaml
|
||||
automation:
|
||||
- alias: "Kids Bedtime - Block Entertainment"
|
||||
@@ -63,74 +59,9 @@ automation:
|
||||
- youtube
|
||||
- netflix
|
||||
- gaming
|
||||
- social
|
||||
```
|
||||
|
||||
### Work Productivity - Focus Mode
|
||||
```yaml
|
||||
automation:
|
||||
- alias: "Work Focus Mode"
|
||||
trigger:
|
||||
platform: state
|
||||
entity_id: input_boolean.work_focus_mode
|
||||
to: 'on'
|
||||
action:
|
||||
service: adguard_hub.bulk_update_clients
|
||||
data:
|
||||
client_pattern: "Work*"
|
||||
settings:
|
||||
blocked_services: ["social", "entertainment", "shopping"]
|
||||
```
|
||||
|
||||
### Emergency Unblock
|
||||
```yaml
|
||||
service: adguard_hub.emergency_unblock
|
||||
data:
|
||||
duration: 600 # 10 minutes
|
||||
clients: ["all"]
|
||||
```
|
||||
|
||||
## 📱 Dashboard Examples
|
||||
|
||||
**Main Control Panel:**
|
||||
```yaml
|
||||
type: vertical-stack
|
||||
title: 🛡️ AdGuard Control Hub
|
||||
cards:
|
||||
- type: glance
|
||||
entities:
|
||||
- switch.adguard_protection
|
||||
- sensor.adguard_blocked_percentage
|
||||
- sensor.adguard_queries_today
|
||||
- sensor.adguard_blocked_today
|
||||
|
||||
- type: entities
|
||||
title: Family Devices
|
||||
entities:
|
||||
- switch.adguard_client_kids_ipad
|
||||
- switch.adguard_client_work_laptop
|
||||
- switch.adguard_client_guest_network
|
||||
```
|
||||
|
||||
**Emergency Button:**
|
||||
```yaml
|
||||
type: button
|
||||
name: "🚨 Emergency Unblock"
|
||||
icon: mdi:shield-off
|
||||
tap_action:
|
||||
action: call-service
|
||||
service: adguard_hub.emergency_unblock
|
||||
service_data:
|
||||
duration: 600
|
||||
clients: ["all"]
|
||||
```
|
||||
|
||||
## 🤝 Support & Contribution
|
||||
- Full documentation and setup examples in the repository wiki.
|
||||
- Report issues or request features via the repository's issue tracker.
|
||||
- Contributions welcome—please read the contribution guidelines.
|
||||
|
||||
## 📄 License
|
||||
This project is licensed under the MIT License. See the LICENSE file for details.
|
||||
This project is licensed under the MIT License.
|
||||
|
||||
Made with ❤️ and professional care, so you control your AdGuard Home network integration!
|
||||
Made with ❤️ for Home Assistant and AdGuard Home users!
|
Reference in New Issue
Block a user