Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adguard home #397

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions adguard.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
{
"Adguard-home": {
"containers": {
"adguard": {
"image": "adguard/adguardhome",
"launch_order": 1,
"opts": [
[
"--net=adguard-home",
Hooverdan96 marked this conversation as resolved.
Show resolved Hide resolved
""
]
],
"ports": {
"53": {
"description": "DNS port",
"label": "DNS Port",
"host_default": 53
},
"67": {
"description": "DHCP port",
"label": "DHCP Port",
"host_default": 67,
"protocol": "udp"
},
"68": {
"description": "DHCP port",
"label": "DHCP Port",
"host_default": 68,
"protocol": "udp"
},
"80": {
"description": "Admin WebUI port no ssl",
"host_default": 80,
"protocol": "tcp",
"label": "WebUI Port no ssl"
},
"443": {
"description": "Admin WebUI port ssl",
"host_default": 443,
"label": "WebUI Port ssl"
},
"3000": {
"description": "WebUI Config port",
"host_default": 3000,
"label": "Port for initial Config"
},
"853": {
"description": "DNS over TLS Port",
"host_default": 853,
"label": "DNS over TLS Port"
},
"784": {
"description": "DNS over Quic Port",
"host_default": 784,
"label": "DNS over Quic Port"
},
"5443": {
"description": "DNSCrypt port",
"host_default": 5443,
"label": "DNSCrypt Port"
}
},
"volumes": {
"/opt/adguardhome/conf": {
"description": "Choose a Share for Adguard config.",
"label": "Choose a Share for Adguard config."
},
"/opt/adguardhome/work": {
"description": "Choose a Share for Adguard data.",
"label": "Choose a Share for Adguard data."
}
}
}
},
"description": "AdGuard Home is a network-wide software for blocking ads and tracking. After you set it up, it'll cover all your home devices, and you won't need any client-side software for that. <p>Based on the official Image: <a href='https://hub.docker.com/r/adguard/adguardhome' target='_blank'>https://hub.docker.com/r/adguard/adguardhome</a>, available for amd64 and arm64 architecture.</p> <p>Create a macvlan to avoid overlapping of ports which are needed by Adguard like 443 & 80. E.g., <code>docker network create -d macvlan --subnet=192.168.178.0/24 --ip-range=192.168.178.58/32 --gateway=192.168.178.1 -o parent=eth0 adguard-home</code></p><p>The docker network has to be named <code>adguard-home</code>!</p> <p>The UI is reachable under the IP-Adress definded in the maxvlan. E.g.: <code>--ip-range=192.168.178</code> and the WebUI-Config Port. E.g.: <code>http://192.168.178.58:3000</code> </p>",
Copy link
Member

@Hooverdan96 Hooverdan96 Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "AdGuard Home is a network-wide software for blocking ads and tracking. After you set it up, it'll cover all your home devices, and you won't need any client-side software for that. <p>Based on the official Image: <a href='https://hub.docker.com/r/adguard/adguardhome' target='_blank'>https://hub.docker.com/r/adguard/adguardhome</a>, available for amd64 and arm64 architecture.</p> <p>Create a macvlan to avoid overlapping of ports which are needed by Adguard like 443 & 80. E.g., <code>docker network create -d macvlan --subnet=192.168.178.0/24 --ip-range=192.168.178.58/32 --gateway=192.168.178.1 -o parent=eth0 adguard-home</code></p><p>The docker network has to be named <code>adguard-home</code>!</p> <p>The UI is reachable under the IP-Adress definded in the maxvlan. E.g.: <code>--ip-range=192.168.178</code> and the WebUI-Config Port. E.g.: <code>http://192.168.178.58:3000</code> </p>",
"description": "AdGuard Home is a network-wide software for blocking ads and tracking. After you set it up, it'll cover all your home devices, and you won't need any client-side software for that. <p>Based on the official Image: <a href='https://hub.docker.com/r/adguard/adguardhome' target='_blank'>https://hub.docker.com/r/adguard/adguardhome</a>, available for amd64 and arm64 architecture.</p> <p>Create a macvlan to avoid overlapping of ports which are needed by Adguard like 443 & 80. E.g., <code>docker network create -d macvlan --subnet=192.168.178.0/24 --ip-range=192.168.178.58/32 --gateway=192.168.178.1 -o parent=eth0 adguard-home</code></p><p>The docker network has to be named <code>adguard-home</code>!</p> <p>For the initial setup the UI is reachable under the IP-Adress defined in the macvlan. E.g.: <code>192.168.178.58</code>. and the setup port <code>3000</code>, i.e.: <code>http://192.168.178.58:3000</code>. Once setup is complete, the admin page can be reached using port <code>80</code> e.g.,<code>http://192.168.178.58:80</code>.</p>",

Copy link
Member

@Hooverdan96 Hooverdan96 Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know, I'm suggesting more words to be added to the description (whereas @phillxnet is trying to get us to reduce the verbiage in this space), but I think it's relevant to point out that the initial setup port and the "daily" ports will be different. And in absence of a formal writeup in the Rockstor documentation, this will be the only place to clarify that.

"website": "https://hub.docker.com/r/adguard/adguardhome",
"version": "1.0"
}
}
1 change: 1 addition & 0 deletions root.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"2FAuth": "2FAuth.json",
"AdGuard Home": "adguard.json",
"Airsonic Advanced": "airsonic-advanced.json",
"Booksonic": "booksonic.json",
"Calibre": "calibre.json",
Expand Down