Skip to content

syathiby/AdGuardHome-configs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

AdGuardHome Configuration Backup

📖 Overview

We implement comprehensive internet safety and security measures for our educational environment. This repository contains the configuration backup for AdGuardHome, our DNS-based content filtering solution that protects students from inappropriate content and enhances network security.

📁 Repository Structure

AdGuardHome-configs/
│
├── 📄 README.md                 # This documentation file
├── 📄 AdGuardHome.yaml          # Main configuration file
├── 📄 permission-fix.bat        # Ownership utility for backup/repair operations
│
├── 📁 data/                     # AdGuardHome data directory
│   ├── 📄 sessions.db           # User sessions database
│   ├── 📄 stats.db              # Statistics database
│   └── 📁 filters/              # Custom filter directory
│       ├── 📄 1.txt             # Filter list 1
│       ├── 📄 2.txt             # Filter list 2
│       └── 📄 ...               # Additional filter lists

🚀 Installation & Setup Guide

Prerequisites

  • AdGuardHome installed on Windows
  • PowerShell 5.1 or newer
  • Administrative privileges

Fresh Installation Steps

  1. Download and Extract AdGuardHome

    # Download latest version from https://github.com/AdguardTeam/AdGuardHome/releases
    # Extract to C:\AdGuardHome (recommended)
  2. Install AdGuardHome Service

    cd C:\AdGuardHome
    AdGuardHome.exe -s install
  3. Initial Setup

    • Open your browser and navigate to http://localhost:3000
    • Follow the initial setup wizard
    • Complete the basic configuration
  4. Stop Service for Configuration

    AdGuardHome.exe -s stop

Applying This Configuration

  1. Run Permission Fix Script (As Administrator)

    # Execute the permission fix utility
    permission-fix.bat
  2. Deploy Configuration Files

    • Copy the data/ directory to C:\AdGuardHome\
    • Replace AdGuardHome.yaml in C:\AdGuardHome\
    • Important: Preserve your encryption password from the original file
  3. Restart Service

    AdGuardHome.exe -s start

⚙️ Configuration Features

Our AdGuardHome configuration includes:

  • Content Filtering: Comprehensive blocking of inappropriate content
  • Security Enhancements: Protection against malware and phishing sites
  • Educational Focus: Whitelisting for educational resources
  • Monitoring: Detailed logging and statistics
  • Custom Rules: Tailored filtering rules for educational environments

🛠️ Troubleshooting

Common Issues and Solutions

  1. Permission Errors

    # Run as Administrator
    permission-fix.bat
  2. Service Won't Start

    # Check logs in C:\AdGuardHome\AdGuardHome.log
    # Verify configuration file syntax
  3. Configuration Validation

    AdGuardHome.exe --check-config

📊 Monitoring and Maintenance

  • Regularly check AdGuardHome.yaml for custom rules updates
  • Monitor filter lists in data/filters/ directory
  • Review statistics in the web interface
  • Schedule regular backups using provided scripts

🔒 Security Notes

  • Always backup original configuration before applying changes
  • Keep encryption passwords secure and never commit to version control
  • Regularly update AdGuardHome to latest version
  • Review and update filter lists periodically

📝 License and Usage

This configuration is provided for educational purposes. Please ensure compliance with:

  • Your organization's IT policies
  • Local regulations regarding content filtering
  • Privacy laws and regulations

🤝 Contributing

To suggest improvements or report issues:

  1. Fork this repository
  2. Create a feature branch
  3. Submit a pull request with detailed description

📞 Support

For technical assistance with this configuration:

  1. Check the AdGuardHome documentation
  2. Review existing issues in this repository
  3. Consult with your network administrator

Note: Always test configurations in a controlled environment before deploying to production systems. Regular backups are essential for maintaining service continuity.

🙏 Credits

AdGuardHome Configuration Backup · GitHub

🏆 Contributors & References

Contributor Role Link
IT Syathiby 2024 Configuration Development & Maintenance GitHub
IT Rodja Initial Guide & Inspiration Website

📚 Reference Materials


About

We take the necessary steps to ensure internet safety and security for our students.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published