{
  "slug": "adguardhome",
  "kind": "compose",
  "metadata": {
    "name": "AdGuard Home",
    "description": "Network-wide DNS-based ad and tracker blocker. AdGuard Home operates as a DNS server that blocks tracking domains, with support for DNS-over-HTTPS, DNS-over-TLS, DNS-over-QUIC, parental controls, and safe browsing filters.",
    "tags": [
      "traefik",
      "network",
      "volume"
    ],
    "icon": {
      "provider": "selfhst",
      "id": "adguard-home"
    },
    "draft": false,
    "version": {
      "name": "v0.107.74",
      "source_dep_name": "docker.io/adguard/adguardhome",
      "source_dep_version": "v0.107.74"
    }
  },
  "variables": [
    {
      "title": "General",
      "name": "general",
      "items": [
        {
          "name": "service_name",
          "type": "str",
          "title": "Service Name",
          "required": false,
          "default": "adguardhome",
          "config": {
            "placeholder": "adguardhome"
          }
        },
        {
          "name": "restart_policy",
          "type": "enum",
          "title": "Restart Policy",
          "required": true,
          "default": "unless-stopped",
          "config": {
            "options": [
              "unless-stopped",
              "always",
              "on-failure",
              "no"
            ]
          }
        },
        {
          "name": "initial_setup",
          "type": "bool",
          "title": "Initial Setup",
          "required": false,
          "default": true,
          "description": "Enable initial setup wizard on port 3000 (only used without Traefik)"
        }
      ]
    },
    {
      "title": "Network",
      "name": "network",
      "items": [
        {
          "name": "network_mode",
          "type": "str",
          "title": "Network Mode",
          "required": false
        },
        {
          "name": "network_name",
          "type": "str",
          "title": "Network Name",
          "required": false,
          "default": "adguardhome_network",
          "config": {
            "placeholder": "adguardhome_network"
          }
        },
        {
          "name": "network_macvlan_ipv4_address",
          "type": "str",
          "title": "IPv4 Address",
          "required": true,
          "default": "IP_ADDRESS",
          "needs": [
            "network_mode=macvlan"
          ],
          "config": {
            "placeholder": "IP_ADDRESS"
          }
        },
        {
          "name": "network_macvlan_parent_interface",
          "type": "str",
          "title": "Parent Interface",
          "required": true,
          "default": "eth0",
          "needs": [
            "network_mode=macvlan"
          ],
          "config": {
            "placeholder": "eth0"
          }
        },
        {
          "name": "network_macvlan_subnet",
          "type": "str",
          "title": "Subnet",
          "required": true,
          "default": "IP_RANGE",
          "needs": [
            "network_mode=macvlan"
          ],
          "config": {
            "placeholder": "IP_RANGE"
          }
        },
        {
          "name": "network_macvlan_gateway",
          "type": "str",
          "title": "Gateway",
          "required": true,
          "default": "GATEWAY",
          "needs": [
            "network_mode=macvlan"
          ],
          "config": {
            "placeholder": "GATEWAY"
          }
        },
        {
          "name": "network_external",
          "type": "bool",
          "title": "External Network",
          "required": false,
          "default": false
        }
      ]
    },
    {
      "title": "Ports",
      "name": "ports",
      "items": [
        {
          "name": "ports_http",
          "type": "str",
          "title": "HTTP Port",
          "required": false,
          "default": 80,
          "config": {
            "placeholder": "80"
          }
        },
        {
          "name": "ports_https",
          "type": "str",
          "title": "HTTPS Port",
          "required": false,
          "default": 443,
          "config": {
            "placeholder": "443"
          }
        },
        {
          "name": "ports_dns",
          "type": "int",
          "title": "DNS Port",
          "required": true,
          "default": 53,
          "config": {
            "placeholder": "53"
          }
        },
        {
          "name": "ports_initial",
          "type": "int",
          "title": "Initial Setup Port",
          "required": false,
          "default": 3000,
          "description": "Initial setup wizard port (only when Traefik is disabled)",
          "needs": [
            "traefik_enabled=false",
            "initial_setup=true"
          ],
          "config": {
            "placeholder": "3000"
          }
        },
        {
          "name": "ports_tls",
          "type": "int",
          "title": "DoT Port",
          "required": true,
          "default": 853,
          "config": {
            "placeholder": "853"
          }
        },
        {
          "name": "ports_dnscrypt",
          "type": "int",
          "title": "DNSCrypt Port",
          "required": true,
          "default": 5443,
          "config": {
            "placeholder": "5443"
          }
        }
      ]
    },
    {
      "title": "Traefik",
      "name": "traefik",
      "toggle": "traefik_enabled",
      "items": [
        {
          "name": "traefik_enabled",
          "type": "bool",
          "title": "Traefik",
          "required": false,
          "default": false
        },
        {
          "name": "traefik_host",
          "type": "str",
          "title": "Host",
          "required": true,
          "config": {
            "placeholder": "adguardhome"
          }
        },
        {
          "name": "traefik_domain",
          "type": "str",
          "title": "Domain",
          "required": true,
          "config": {
            "placeholder": "home.arpa"
          }
        },
        {
          "name": "traefik_entrypoint",
          "type": "str",
          "title": "Entrypoint",
          "required": true,
          "default": "web",
          "config": {
            "placeholder": "web"
          }
        },
        {
          "name": "traefik_network",
          "type": "str",
          "title": "Network",
          "required": true,
          "default": "traefik",
          "config": {
            "placeholder": "traefik"
          }
        },
        {
          "name": "traefik_tls_enabled",
          "type": "bool",
          "title": "TLS",
          "required": false,
          "default": false
        },
        {
          "name": "traefik_tls_entrypoint",
          "type": "str",
          "title": "TLS Entrypoint",
          "required": true,
          "default": "websecure",
          "config": {
            "placeholder": "websecure"
          },
          "needs": [
            "traefik_tls_enabled=true"
          ]
        },
        {
          "name": "traefik_tls_certresolver",
          "type": "str",
          "title": "Cert Resolver",
          "required": true,
          "default": "cloudflare",
          "config": {
            "placeholder": "cloudflare"
          },
          "needs": [
            "traefik_tls_enabled=true"
          ]
        }
      ]
    },
    {
      "title": "Volume",
      "name": "volume",
      "items": [
        {
          "name": "volume_mode",
          "type": "enum",
          "title": "Volume Mode",
          "required": true,
          "default": "local",
          "config": {
            "options": [
              "local",
              "mount",
              "nfs"
            ]
          }
        },
        {
          "name": "volume_mount_path",
          "type": "str",
          "title": "Volume Mount Path",
          "required": true,
          "default": "/data",
          "needs": [
            "volume_mode=mount"
          ],
          "config": {
            "placeholder": "/data"
          }
        },
        {
          "name": "volume_nfs_server",
          "type": "str",
          "title": "Volume Nfs Server",
          "required": true,
          "default": "NFS_SERVER",
          "needs": [
            "volume_mode=nfs"
          ],
          "config": {
            "placeholder": "NFS_SERVER"
          }
        },
        {
          "name": "volume_nfs_path",
          "type": "str",
          "title": "Volume Nfs Path",
          "required": true,
          "default": "/export",
          "needs": [
            "volume_mode=nfs"
          ],
          "config": {
            "placeholder": "/export"
          }
        },
        {
          "name": "volume_nfs_options",
          "type": "str",
          "title": "Volume Nfs Options",
          "required": true,
          "default": "rw,nolock,soft",
          "needs": [
            "volume_mode=nfs"
          ],
          "config": {
            "placeholder": "rw,nolock,soft"
          }
        }
      ]
    }
  ]
}