homelab-optimized/docs/services/individual/adguard.md

Adguard

🟡 Security Service

📋 Service Overview

Property	Value
Service Name	adguard
Host	setillo
Category	Security
Difficulty	🟡
Docker Image	adguard/adguardhome
Compose File	setillo/adguard/adguard-stack.yaml
Directory	setillo/adguard

🎯 Purpose

AdGuard Home is a network-wide software for blocking ads & tracking.

🚀 Quick Start

Prerequisites

• Docker and Docker Compose installed
• Basic understanding of REDACTED_APP_PASSWORD
• Access to the host system (setillo)

Deployment

# Navigate to service directory
cd setillo/adguard

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f adguard

🔧 Configuration

Docker Compose Configuration

container_name: adguard
environment:
- TZ=America/Phoenix
image: adguard/adguardhome
network_mode: host
restart: always
volumes:
- /volume1/docker/adguard/config:/opt/adguardhome/conf
- /volume1/docker/adguard/data:/opt/adguardhome/work

Environment Variables

Variable	Value	Description
TZ	America/Phoenix	Timezone setting

Port Mappings

No ports exposed.

Volume Mappings

Host Path	Container Path	Type	Purpose
/volume1/docker/adguard/config	/opt/adguardhome/conf	bind	Data storage
/volume1/docker/adguard/data	/opt/adguardhome/work	bind	Data storage

🌐 Access Information

This service does not expose any web interfaces.

🔒 Security Considerations

• ⚠️ Consider adding security options (no-new-privileges)
• ⚠️ Consider running as non-root user

📊 Resource Requirements

No resource limits configured

Recommended Resources

• Minimum RAM: 512MB
• Recommended RAM: 1GB+
• CPU: 1 core minimum
• Storage: Varies by usage

Resource Monitoring

Monitor resource usage with:

docker stats

🔍 Health Monitoring

⚠️ No health check configured Consider adding a health check:

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
  interval: 30s
  timeout: 10s
  retries: 3

Manual Health Checks

# Check container health
docker inspect --format='{{.State.Health.Status}}' CONTAINER_NAME

# View health check logs
docker inspect --format='{{range .State.Health.Log}}{{.Output}}{{end}}' CONTAINER_NAME

🚨 Troubleshooting

Common Issues

Service won't start

• Check Docker logs: docker-compose logs service-name
• Verify port availability: netstat -tulpn | grep PORT
• Check file permissions on mounted volumes

Can't access web interface

• Verify service is running: docker-compose ps
• Check firewall settings
• Confirm correct port mapping

Performance issues

• Monitor resource usage: docker stats
• Check available disk space: df -h
• Review service logs for errors

Authentication issues

• Verify credentials are correct
• Check LDAP/SSO configuration
• Review authentication logs

Useful Commands

# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f adguard

# Restart service
docker-compose restart adguard

# Update service
docker-compose pull adguard
docker-compose up -d adguard

# Access service shell
docker-compose exec adguard /bin/bash
# or
docker-compose exec adguard /bin/sh

📚 Additional Resources

• Official Documentation: Check the official docs for adguard
• Docker Hub: adguard/adguardhome
• Community Forums: Search for community discussions and solutions
• GitHub Issues: Check the project's GitHub for known issues

🔗 Related Services

Services REDACTED_APP_PASSWORD adguard:

• Vaultwarden
• Authelia
• Pi-hole
• WireGuard

---

This documentation is auto-generated from the Docker Compose configuration. For the most up-to-date information, refer to the official documentation and the actual compose file.

Last Updated: 2025-11-17
Configuration Source: setillo/adguard/adguard-stack.yaml