diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 894f3c29e..9ad997469 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,12 +1,12 @@ 'body': - 'attributes': 'description': > - Please make sure that the issue is not a duplicate or a question. If it's a duplicate, please react to the original issue with a thumbs up. If it's a question, please post it to the GitHub Discussions page. + Please make sure that the issue is not a duplicate or a question. If it's a duplicate, please react to the original issue with a thumbs up. If it's a question, please post it to the GitHub Discussions page. 'label': 'Prerequisites' 'options': - 'label': > - I have checked the [Wiki](https://github.com/AdguardTeam/AdGuardHome/wiki) and [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a) and found no answer + I have checked the [AdGuard DNS Knowledge Base](https://adguard-dns.io/kb/adguard-home/overview/) and [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a) and found no answer 'required': true - 'label': > @@ -18,14 +18,14 @@ 'required': true - 'label': > - I have set up AdGuard Home correctly and [configured clients to use it](https://github.com/AdguardTeam/AdGuardHome/wiki/Clients). (Use the [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a) for help with installing and configuring clients.) + I have set up AdGuard Home correctly and [configured clients to use it](https://adguard-dns.io/kb/adguard-home/clients/). (Use the [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a) for help with installing and configuring clients.) 'required': true 'id': 'prerequisites' 'type': 'checkboxes' - 'attributes': 'description': 'On which Platform does the issue occur?' - 'label': 'Platform (OS and CPU architecture)' + 'label': 'Platform (OS and CPU Architecture)' # NOTE: Keep the 386 at the bottom for each OS, because a lot of people # Seem to confuse them with AMD64, which is what they actually need. 'options': @@ -85,7 +85,7 @@ 'required': true - 'attributes': 'description': 'What version of AdGuard Home are you using?' - 'label': 'AdGuard Home version' + 'label': 'AdGuard Home Version' 'id': 'version' 'type': 'input' 'validations': @@ -110,7 +110,7 @@ 'description': > What did you expect to see? Please add a description and/or screenshots, if applicable. - 'label': 'Expected result' + 'label': 'Expected Result' 'placeholder': > What did you expect to see? @@ -120,9 +120,9 @@ 'required': true - 'attributes': 'description': > - What happened instead? Please add a description and/or screenshots, if applicable. + What happened instead? Please add a description and/or screenshots, if applicable. - 'label': 'Actual result' + 'label': 'Actual Result' 'placeholder': > What did you see instead? @@ -132,9 +132,9 @@ 'required': true - 'attributes': 'description': > - Please add additional information, such as non-standard OS or port, here. You can also put screenshots here, if applicable. For example, it is better to copy and paste text from a terminal instead of posting a screenshot of the terminal. + Please add additional information, such as non-standard OS or port, here. You can also put screenshots here, if applicable. For example, it is better to copy and paste text from a terminal instead of posting a screenshot of the terminal. - 'label': 'Additional information and/or screenshots' + 'label': 'Additional Information and/or Screenshots' 'placeholder': > Additional OS information, screenshots of the UI, etc. @@ -145,7 +145,7 @@ # NOTE: GitHub limits the description length to 200 characters. Also, Markdown # doesn't work here. 'description': | - For help, use the Discussions section instead. Write the title in English - to make it easier for other people to search for duplicates. (Any language + For help, use the Discussions section instead. Write the title in English + to make it easier for other people to search for duplicates. (Any language is fine in the body.) 'name': 'Bug' diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f6ee99ad5..97348a53d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -16,7 +16,7 @@ 'name': 'Q&A Discussions' 'url': 'https://github.com/AdguardTeam/AdGuardHome/discussions' - 'about': > - Please check our Wiki for configuration file description, frequently asked questions, and other documentation + Please check our Knowledge Base for configuration file description, frequently asked questions, and other documentation - 'name': 'Wiki' - 'url': 'https://github.com/AdguardTeam/AdGuardHome/wiki' + 'name': 'AdGuard DNS Knowledge Base' + 'url': 'https://adguard-dns.io/kb/adguard-home/overview/' diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 56569f5c2..328654c72 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,12 +1,12 @@ 'body': - 'attributes': 'description': > - Please make sure that the issue is not a duplicate or a question. If it's a duplicate, please react to the original issue with a thumbs up. If it's a question, please post it to the GitHub Discussions page. + Please make sure that the issue is not a duplicate or a question. If it's a duplicate, please react to the original issue with a thumbs up. If it's a question, please post it to the GitHub Discussions page. 'label': 'Prerequisites' 'options': - 'label': > - I have checked the [Wiki](https://github.com/AdguardTeam/AdGuardHome/wiki) and [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions) and found no answer + I have checked the [AdGuard DNS Knowledge Base](https://adguard-dns.io/kb/adguard-home/overview/) and [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions) and found no answer 'required': true - 'label': > @@ -21,7 +21,7 @@ 'type': 'checkboxes' - 'attributes': 'description': 'Please describe the problem you are trying to solve' - 'label': 'The problem' + 'label': 'Issue Details' 'placeholder': > Please describe the problem you are trying to solve @@ -31,7 +31,7 @@ 'required': true - 'attributes': 'description': 'What feature are you proposing to solve this problem?' - 'label': 'Proposed solution' + 'label': 'Proposed Solution' 'placeholder': > What feature are you proposing to solve this problem? @@ -40,7 +40,7 @@ 'validations': 'required': true - 'attributes': - 'label': 'Alternatives considered and additional information' + 'label': 'Alternative Solution & Additional Information' 'placeholder': > Are there any other ways to solve the problem? @@ -52,7 +52,7 @@ # doesn't work here. 'description': | Write the title in English to make it easier for other people to search for - duplicates. (Any language is fine in the body.) + duplicates. (Any language is fine in the body.) 'labels': - 'feature request' 'name': 'Feature request or enhancement' diff --git a/README.md b/README.md index 1cc08d285..b005d4ef3 100644 --- a/README.md +++ b/README.md @@ -7,31 +7,21 @@

Privacy protection center for you and your devices

- Free and open source, powerful network-wide ads & trackers blocking DNS server. + Free and open source, powerful network-wide DNS server blocking ads & trackers.

- AdGuard.com | - Wiki | + Website | + Knowledge Base | Reddit | - Twitter | + X | Telegram

- - Code Coverage - - - Go Report Card - - - Docker Pulls - + Code Coverage + Go Report Card + Docker Pulls
- - Latest release - - - adguard-home - + Latest release + adguard-home


@@ -39,7 +29,7 @@

-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 don't need any client-side software for that. +AdGuard Home is software for blocking ads and tracking network-wide. After you set it up, it'll cover ALL your home devices, and you don't need any client-side software for that. It operates as a DNS server that re-routes tracking domains to a “black hole”, thus preventing your devices from connecting to those servers. It's based on software we use for our public [AdGuard DNS] servers, and both share a lot of code. @@ -67,9 +57,9 @@ It operates as a DNS server that re-routes tracking domains to a “black hole - [Acknowledgments](#acknowledgments) - [Privacy](#privacy) -## Getting Started +## Getting Started -### Automated install (Linux/Unix/MacOS/FreeBSD/OpenBSD) +### Automated install (Linux/Unix/MacOS/FreeBSD/OpenBSD) To install with `curl` run the following command: @@ -98,17 +88,17 @@ The script also accepts some options: Note that options `-r` and `-u` are mutually exclusive. -### Alternative methods +### Alternative methods -#### Manual installation +#### Manual installation -Please read the **[Getting Started][wiki-start]** article on our Wiki to learn how to install AdGuard Home manually, and how to configure your devices to use it. +Please read the **[Getting Started][wiki-start]** article on our Knowledge Base to learn how to install AdGuard Home manually, and how to configure your devices to use it. -#### Docker +#### Docker You can use our official Docker image on [Docker Hub]. -#### Snap Store +#### Snap Store If you're running **Linux,** there's a secure and easy way to install AdGuard Home: get it from the [Snap Store]. @@ -116,13 +106,13 @@ If you're running **Linux,** there's a secure and easy way to install AdGuard Ho [Snap Store]: https://snapcraft.io/adguard-home [wiki-start]: https://adguard-dns.io/kb/adguard-home/getting-started/ -### Guides +### Guides -See our [Wiki][wiki]. +See our [Knowledge Base][wiki]. -[wiki]: https://github.com/AdguardTeam/AdGuardHome/wiki +[wiki]: https://adguard-dns.io/kb/adguard-home/overview/ -### API +### API If you want to integrate with AdGuard Home, you can use our [REST API][openapi]. Alternatively, you can use this [python client][pyclient], which can be used to build the [AdGuard Home Assistant integration][assistant-integration]. @@ -130,9 +120,9 @@ If you want to integrate with AdGuard Home, you can use our [REST API][openapi]. [openapi]: https://github.com/AdguardTeam/AdGuardHome/tree/master/openapi [pyclient]: https://pypi.org/project/adguardhome/ -## Comparing AdGuard Home to other solutions +## Comparing AdGuard Home to other solutions -### How is this different from public AdGuard DNS servers? +### How is this different from public AdGuard DNS servers? Running your own AdGuard Home server allows you to do much more than using a public DNS server. It's a completely different level. See for yourself: @@ -144,7 +134,7 @@ Running your own AdGuard Home server allows you to do much more than using a pub - **Most importantly, it's your own server, and you are the only one who's in control.** -### How does AdGuard Home compare to Pi-Hole +### How does AdGuard Home compare to Pi-Hole At this point, AdGuard Home has a lot in common with Pi-Hole. Both block ads and trackers using the so-called “DNS sinkholing” method and both allow customizing what's blocked. @@ -174,7 +164,7 @@ AdGuard Home provides a lot of features out-of-the-box with no need to install a [wiki-noroot]: https://adguard-dns.io/kb/adguard-home/getting-started/#running-without-superuser -### How does AdGuard Home compare to traditional ad blockers +### How does AdGuard Home compare to traditional ad blockers It depends. @@ -182,13 +172,13 @@ DNS sinkholing is capable of blocking a big percentage of ads, but it lacks the Additionally, using a DNS-based blocker can help to block ads, tracking and analytics requests on other types of devices, such as SmartTVs, smart speakers or other kinds of IoT devices (on which you can't install traditional ad blockers). -### Known limitations +### Known limitations Here are some examples of what cannot be blocked by a DNS-level blocker: - YouTube, Twitch ads; -- Facebook, Twitter, Instagram sponsored posts. +- Facebook, X, Instagram sponsored posts. Essentially, any advertising that shares a domain with content cannot be blocked by a DNS-level blocker. @@ -197,9 +187,9 @@ Is there a chance to handle this in the future? DNS will never be enough to do [blog-adaway]: https://adguard.com/blog/adguard-vs-adaway-dns66.html [issue-1228]: https://github.com/AdguardTeam/AdGuardHome/issues/1228 -## How to build from source +## How to build from source -### Prerequisites +### Prerequisites Run `make init` to prepare the development environment. @@ -209,7 +199,7 @@ You will need this to build AdGuard Home: - [Node.js](https://nodejs.org/en/download/) v24.10.0 or later; - [npm](https://www.npmjs.com/) v10.8 or later; -### Building +### Building Open your terminal and execute these commands: @@ -224,7 +214,7 @@ make Check the [`Makefile`][src-makefile] to learn about other commands. -#### Building for a different platform +#### Building for a different platform You can build AdGuard Home for any OS/ARCH that Go supports. In order to do this, specify `GOOS` and `GOARCH` environment variables as macros when running `make`. @@ -240,7 +230,7 @@ or: make GOOS='linux' GOARCH='arm64' ``` -#### Preparing releases +#### Preparing releases You'll need [`snapcraft`] to prepare a release build. Once installed, run the following command: @@ -250,7 +240,7 @@ make build-release CHANNEL='...' VERSION='...' See the [`build-release` target documentation][targ-release]. -#### Docker image +#### Docker image Run `make build-docker` to build the Docker image locally (the one that we publish to DockerHub). Please note, that we're using [Docker Buildx][buildx] to build our official image. @@ -270,7 +260,7 @@ You may need to prepare before using these builds: See the [`build-docker` target documentation][targ-docker]. -#### Debugging the frontend +#### Debugging the frontend When you need to debug the frontend without recompiling the production version every time, for example to check how your labels would look on a form, you can run the frontend build a development environment. @@ -290,7 +280,7 @@ When you need to debug the frontend without recompiling the production version e [targ-docker]: https://github.com/AdguardTeam/AdGuardHome/tree/master/scripts#build-dockersh-build-a-multi-architecture-docker-image [targ-release]: https://github.com/AdguardTeam/AdGuardHome/tree/master/scripts#build-releasesh-build-a-release-for-all-platforms -#### End-to-End (E2E) Frontend Tests +#### End-to-End (E2E) Frontend Tests AdGuard Home uses [Playwright](https://playwright.dev) for E2E testing. Tests are located in `tests/e2e`. @@ -306,7 +296,7 @@ AdGuard Home uses [Playwright](https://playwright.dev) for E2E testing. Tests ar > **Warning:** Playwright will download and install its own browser binaries for testing, which may differ from the browsers installed on your system. -## Contributing +## Contributing You are welcome to fork this repository, make your changes and [submit a pull request][pr]. Please make sure you follow our [code guidelines][guide] though. @@ -315,7 +305,7 @@ Please note that we don't expect people to contribute to both UI and backend par [guide]: https://github.com/AdguardTeam/CodeGuidelines/ [pr]: https://github.com/AdguardTeam/AdGuardHome/pulls -### Test unstable versions +### Test unstable versions There are two update channels that you can use: @@ -345,26 +335,26 @@ There are three options how you can install an unstable version: [wiki-platf]: https://github.com/AdguardTeam/AdGuardHome/wiki/Platforms -### Report issues +### Report issues If you run into any problem or have a suggestion, head to [this page][iss] and click on the “New issue” button. Please follow the instructions in the issue form carefully and don't forget to start by searching for duplicates. [iss]: https://github.com/AdguardTeam/AdGuardHome/issues -### Help with translations +### Help with translations If you want to help with AdGuard Home translations, please learn more about translating AdGuard products [in our Knowledge Base][kb-trans]. You can contribute to the [AdGuardHome project on CrowdIn][crowdin]. [crowdin]: https://crowdin.com/project/adguard-applications/en#/adguard-home -[kb-trans]: https://kb.adguard.com/en/general/adguard-translations +[kb-trans]: https://adguard.com/kb/miscellaneous/contribute/translate/program/ -### Other +### Other Another way you can contribute is by [looking for issues][iss-help] marked as `help wanted`, asking if the issue is up for grabs, and sending a PR fixing the bug or implementing the feature. [iss-help]: https://github.com/AdguardTeam/AdGuardHome/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 -## Projects that use AdGuard Home +## Projects that use AdGuard Home Please note that these projects are not affiliated with AdGuard, but are made by third-party developers and fans. @@ -396,7 +386,7 @@ Please note that these projects are not affiliated with AdGuard, but are made by - [ZimaOS App Store listing](https://www.zimaspace.com/zimaos/app-store/app/org.icewhale.adguardhome) by [ZimaOS Team](https://www.zimaspace.com/zimaos). -## Acknowledgments +## Acknowledgments This software wouldn't have been possible without: @@ -420,8 +410,8 @@ For the full list of all Node.js packages in use, please take a look at [`client [CoreDNS]: https://coredns.io [src-packagejson]: https://github.com/AdguardTeam/AdGuardHome/blob/master/client/package.json -## Privacy +## Privacy Our main idea is that you are the one, who should be in control of your data. So it is only natural, that AdGuard Home does not collect any usage statistics, and does not use any web services unless you configure it to do so. See also the [full privacy policy][privacy] with every bit that *could in theory be sent* by AdGuard Home is available. -[privacy]: https://adguard.com/en/privacy/home.html +[privacy]: https://adguard.com/privacy/home.html