# SimpleGuardHome

SimpleGuardHome is a self-hosted home automation app. A modern web application for checking and adding domains to custom filtering rules in AdGuard Home. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/2246/simpleguardhome

## Description

A modern web application for checking and adding domains to custom filtering rules in AdGuard Home. Built with FastAPI and modern JavaScript, following the official AdGuard Home OpenAPI specification. Meant as a simple AdGuard Home web interface for users to check if a domain is blocked, and then add it.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

33/100 (Low), based on 3 of 4 factors.
- Maintained: 53 (last commit 203 days ago)
- Popular: 0 (0 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/pacnpal/simpleguardhome
- Unraid: https://ca.unraid.net/apps/simpleguardhome-1it3qso1c0uxx0?q=SimpleGuardHome

## Common questions

### Which port does SimpleGuardHome use for its web interface?

It is normally mapped with Docker port 8000 to container port 8000. After starting it, you can access it on localhost port 8000.

### What environment variables does Docker need to connect to AdGuard Home?

Set ADGUARD_HOST and ADGUARD_PORT for the AdGuard Home endpoint. ADGUARD_USERNAME and ADGUARD_PASSWORD are required for the AdGuard Home API credentials.

### Can I run SimpleGuardHome without Docker?

Yes, the README shows a Python installation path using pip and Uvicorn on port 8000. You can also clone the repository and install its requirements into a Python virtual environment.

### Does SimpleGuardHome include API documentation and a health check?

Yes, it lists full OpenAPI/Swagger documentation as a feature. It also includes a health monitoring endpoint.

---
Source: Our Local Host (https://ourlocalhost.com/app/2246/simpleguardhome), the self-hosted and open-source app directory.
