commit 617f5659f94902d33e62edaf7e858d78a37f533d Author: jessikitty Date: Thu Dec 11 00:29:35 2025 +1100 Initial commit: Add README diff --git a/README.md b/README.md new file mode 100644 index 0000000..5880980 --- /dev/null +++ b/README.md @@ -0,0 +1,91 @@ +# OpenWRT and AdGuard Home Configuration Guide + +Complete setup guide for configuring OpenWRT router with AdGuard Home DNS filtering and device access control. + +## Network Configuration + +**Target Setup:** +- OpenWRT Router: `10.0.0.246` +- AdGuard Home DNS: `10.0.0.245` +- DHCP Range: `10.0.0.1 - 10.0.0.200` +- Gateway: `10.0.0.254` (existing TPLink router) + +## Files in this Repository + +### 📖 [openwrt-adguard-setup.md](openwrt-adguard-setup.md) +Comprehensive configuration guide covering: +- Initial OpenWRT setup and network configuration +- DHCP server configuration with static leases +- Custom DNS settings per client +- Multiple access control methods +- AdGuard Home installation and configuration +- Integration and testing procedures +- Troubleshooting and maintenance + +### 🔧 [device-control.sh](device-control.sh) +Bash script for easy device access management: +- Block/unblock devices from internet access +- List all currently blocked devices +- Check device blocking status +- View action logs +- Simple command-line interface + +### ✅ [setup-checklist.md](setup-checklist.md) +Step-by-step checklist with: +- Pre-setup information gathering +- Phase-by-phase setup tracking +- Testing procedures +- Backup creation steps +- Maintenance schedule +- Troubleshooting quick reference + +## Quick Start + +1. Follow the **setup-checklist.md** for a guided setup process +2. Refer to **openwrt-adguard-setup.md** for detailed explanations +3. Deploy **device-control.sh** to your OpenWRT router for easy device management + +## Features + +✅ DHCP server with customizable range +✅ Static IP assignment for critical devices +✅ Per-client DNS server configuration +✅ Device-level internet access control +✅ AdGuard Home DNS filtering and ad-blocking +✅ Local DNS name resolution +✅ Comprehensive logging and monitoring + +## Device Access Control + +Simple commands to manage device access: + +```bash +# Block a device +./device-control.sh block 10.0.0.100 "Kids Tablet" + +# Unblock a device +./device-control.sh unblock 10.0.0.100 + +# List all blocked devices +./device-control.sh list + +# Check device status +./device-control.sh status 10.0.0.100 +``` + +## Prerequisites + +- OpenWRT router (any compatible device) +- Server/device for AdGuard Home (Docker, Linux, or Windows) +- Basic networking knowledge +- SSH access to OpenWRT + +## Support + +Refer to the comprehensive troubleshooting sections in the main guide, or consult: +- [OpenWRT Forum](https://forum.openwrt.org/) +- [AdGuard Home Documentation](https://github.com/AdguardTeam/AdGuardHome/wiki) + +## License + +Feel free to use and modify for your own network setup.