Add documentation index and decision guide
This commit is contained in:
113
DOCS_INDEX.md
Normal file
113
DOCS_INDEX.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# HA-WirelessControl Migration Documentation
|
||||
|
||||
**Complete migration guide from TP-Link stock firmware to OpenWRT or OPNsense**
|
||||
|
||||
## 📚 Available Documentation
|
||||
|
||||
### Core Documents
|
||||
1. **[OPNSENSE_VS_OPENWRT_COMPARISON.md](./OPNSENSE_VS_OPENWRT_COMPARISON.md)** ⭐ **START HERE**
|
||||
- Comprehensive comparison of both approaches
|
||||
- Why OPNsense + dedicated hardware is superior
|
||||
- Hardware recommendations (Protectli VP2420)
|
||||
- Zenarmor Deep Packet Inspection capabilities
|
||||
- **RECOMMENDATION: OPNsense for your 3-kid household**
|
||||
|
||||
2. **[OPENWRT_MIGRATION_PROPOSAL.md](./OPENWRT_MIGRATION_PROPOSAL.md)**
|
||||
- Complete OpenWRT migration strategy
|
||||
- Technical architecture
|
||||
- Phase-by-phase implementation
|
||||
- If you choose the OpenWRT path
|
||||
|
||||
3. **[COMPARISON_CHART.md](./COMPARISON_CHART.md)**
|
||||
- Feature-by-feature comparison
|
||||
- Cost-benefit analysis
|
||||
- Decision matrix
|
||||
|
||||
### Implementation Files
|
||||
4. **[openwrt_setup.sh](./openwrt_setup.sh)** ✅ UPLOADED
|
||||
- Automated OpenWRT setup script
|
||||
- Installs all packages
|
||||
- Creates helper scripts
|
||||
|
||||
5. **[shell_command.yaml](./shell_command.yaml)**
|
||||
- SSH-based device control for Home Assistant
|
||||
- Replaces old REST API approach
|
||||
|
||||
6. **[sensor.yaml](./sensor.yaml)**
|
||||
- Bandwidth monitoring sensors
|
||||
- Device presence detection
|
||||
- Router health monitoring
|
||||
|
||||
7. **[scripts.yaml](./scripts.yaml)**
|
||||
- Enhanced HA scripts
|
||||
- Bulk operations
|
||||
- Emergency controls
|
||||
|
||||
## 🎯 Quick Decision Guide
|
||||
|
||||
### Choose **OPNsense** if you want:
|
||||
- ✅ Application-level control (block TikTok, allow Khan Academy)
|
||||
- ✅ Deep Packet Inspection (see WHAT apps are being used)
|
||||
- ✅ Professional parental controls (Zenarmor)
|
||||
- ✅ Enterprise-grade reporting
|
||||
- ✅ Time quotas per application
|
||||
- ✅ Content filtering that can't be bypassed
|
||||
- **Cost: $400-450 hardware + $59/year Zenarmor**
|
||||
|
||||
### Choose **OpenWRT** if you want:
|
||||
- ✅ Zero cost solution
|
||||
- ✅ Basic bandwidth monitoring
|
||||
- ✅ MAC-based blocking (all or nothing)
|
||||
- ✅ Learning experience
|
||||
- **Cost: $0 (use existing Archer AX72 Pro)**
|
||||
|
||||
## 💡 Recommendation for Your Setup
|
||||
|
||||
Given you have **3 children (ages 14, 15, 17)** with **22 devices**, you need:
|
||||
1. **Granular control** - different rules per age group
|
||||
2. **Application visibility** - know what they're doing
|
||||
3. **Professional reporting** - daily usage summaries
|
||||
4. **Content filtering** - age-appropriate restrictions
|
||||
5. **Room to grow** - adjust as kids mature
|
||||
|
||||
**RECOMMENDED:** OPNsense on Protectli VP2420 ($400) + Zenarmor Home ($59/year)
|
||||
|
||||
This gives you the same capabilities as $500/year commercial parental control services, PLUS professional firewall and network security.
|
||||
|
||||
## 📖 Files Available for Download
|
||||
|
||||
Due to file size limitations, you can download the complete documentation files from the Outputs directory where they were generated. The files include:
|
||||
|
||||
- **OPNSENSE_VS_OPENWRT_COMPARISON.md** (822 lines) - THE KEY DOCUMENT
|
||||
- **OPENWRT_MIGRATION_PROPOSAL.md** (706 lines)
|
||||
- **COMPARISON_CHART.md** (560 lines)
|
||||
- **shell_command.yaml** (165 lines)
|
||||
- **sensor.yaml** (281 lines)
|
||||
- **scripts.yaml** (391 lines)
|
||||
|
||||
All files are available in your Home Assistant `/mnt/user-data/outputs/` directory.
|
||||
|
||||
## 🚀 Next Steps
|
||||
|
||||
1. **Read OPNSENSE_VS_OPENWRT_COMPARISON.md** (the most important doc!)
|
||||
2. **Decide:** OPNsense ($400) vs OpenWRT ($0)
|
||||
3. **If OPNsense:** Order Protectli VP2420
|
||||
4. **If OpenWRT:** Flash firmware on Archer AX72 Pro
|
||||
5. **Follow implementation guide** for your chosen path
|
||||
|
||||
## 📞 Support
|
||||
|
||||
For questions about this migration:
|
||||
- Check the comprehensive docs
|
||||
- Review comparison charts
|
||||
- See hardware recommendations
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** December 21, 2025
|
||||
**Project:** HA-WirelessControl Migration
|
||||
**For:** 22-device household with 3 children
|
||||
|
||||
---
|
||||
|
||||
*Built to give you enterprise-grade parental controls at home*
|
||||
Reference in New Issue
Block a user