diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index dbe2bad3..bc2caa31 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,7 +1,7 @@ 'name': 'build' 'env': - 'GO_VERSION': '1.18.6' + 'GO_VERSION': '1.18.7' 'NODE_VERSION': '14' 'on': diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 64719a3e..1028b6b1 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,7 +1,7 @@ 'name': 'lint' 'env': - 'GO_VERSION': '1.18.6' + 'GO_VERSION': '1.18.7' 'on': 'push': diff --git a/CHANGELOG.md b/CHANGELOG.md index 51adea62..bbeec92c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,30 +11,80 @@ and this project adheres to ## [Unreleased] - -### Added - -- The new optional `tls.override_tls_ciphers` property list, which can be set in - the configuration file. It allows overriding TLS Ciphers that are used for - https listeners ([#4925]) - -[#4925]: https://github.com/AdguardTeam/AdGuardHome/issues/4925 - +## Added + +- The new optional `tls.override_tls_ciphers` property, which allows + overriding TLS ciphers used by AdGuard Home ([#4925], [#4990]). +- The ability to serve DNS on link-local IPv6 addresses ([#2926]). +- The ability to put [ClientIDs][clientid] into DNS-over-HTTPS hostnames as + opposed to URL paths ([#3418]). Note that AdGuard Home checks the server name + only if the URL does not contain a ClientID. + +### Changed + +- Responses with `SERVFAIL` code are now cached for at least 30 seconds. + +### Fixed + +- The default value of `dns.cache_size` accidentally set to 0 has now been + reverted to 4 MiB ([#5010]). +- Responses for which the DNSSEC validation had explicitly been omitted aren't + cached now ([#4942]). +- Web UI not switching to HTTP/3 ([#4986], [#4993]). + +[#2926]: https://github.com/AdguardTeam/AdGuardHome/issues/2926 +[#3418]: https://github.com/AdguardTeam/AdGuardHome/issues/3418 +[#4925]: https://github.com/AdguardTeam/AdGuardHome/issues/4925 +[#4942]: https://github.com/AdguardTeam/AdGuardHome/issues/4942 +[#4986]: https://github.com/AdguardTeam/AdGuardHome/issues/4986 +[#4990]: https://github.com/AdguardTeam/AdGuardHome/issues/4990 +[#4993]: https://github.com/AdguardTeam/AdGuardHome/issues/4993 +[#5010]: https://github.com/AdguardTeam/AdGuardHome/issues/5010 + +[clientid]: https://github.com/AdguardTeam/AdGuardHome/wiki/Clients#clientid + +<<<<<<< HEAD +||||||| bf792b83f + +======= + +## [v0.107.16] - 2022-10-07 + +This is a security update. There is no GitHub milestone, since no GitHub issues +were resolved. + +## Security + +- Go version has been updated to prevent the possibility of exploiting the + CVE-2022-2879, CVE-2022-2880, and CVE-2022-41715 Go vulnerabilities fixed in + [Go 1.18.7][go-1.18.7]. + +[go-1.18.7]: https://groups.google.com/g/golang-announce/c/xtuG5faxtaU + + + +>>>>>>> master ## [v0.107.15] - 2022-10-03 See also the [v0.107.15 GitHub milestone][ms-v0.107.15]. @@ -57,7 +107,7 @@ experimental and may break or change in the future. explicitly enabled by setting the new property `dns.serve_http3` in the configuration file to `true`. - DNS-over-HTTP upstreams can now upgrade to HTTP/3 if the new configuration - file property `use_http3_upstreams` is set to `true`. + file property `dns.use_http3_upstreams` is set to `true`. - Upstreams with forced DNS-over-HTTP/3 and no fallback to prior HTTP versions using the `h3://` scheme. @@ -171,7 +221,7 @@ See also the [v0.107.12 GitHub milestone][ms-v0.107.12]. ### Security -- Go version was updated to prevent the possibility of exploiting the +- Go version has been updated to prevent the possibility of exploiting the CVE-2022-27664 and CVE-2022-32190 Go vulnerabilities fixed in [Go 1.18.6][go-1.18.6]. @@ -292,7 +342,7 @@ See also the [v0.107.9 GitHub milestone][ms-v0.107.9]. ### Security -- Go version was updated to prevent the possibility of exploiting the +- Go version has been updated to prevent the possibility of exploiting the CVE-2022-32189 Go vulnerability fixed in [Go 1.18.5][go-1.18.5]. Go 1.17 support has also been removed, as it has reached end of life and will not receive security updates. @@ -335,7 +385,7 @@ See also the [v0.107.8 GitHub milestone][ms-v0.107.8]. ### Security -- Go version was updated to prevent the possibility of exploiting the +- Go version has been updated to prevent the possibility of exploiting the CVE-2022-1705, CVE-2022-32148, CVE-2022-30631, and other Go vulnerabilities fixed in [Go 1.17.12][go-1.17.12]. @@ -371,7 +421,7 @@ See also the [v0.107.7 GitHub milestone][ms-v0.107.7]. ### Security -- Go version was updated to prevent the possibility of exploiting the +- Go version has been updated to prevent the possibility of exploiting the [CVE-2022-29526], [CVE-2022-30634], [CVE-2022-30629], [CVE-2022-30580], and [CVE-2022-29804] Go vulnerabilities. - Enforced password strength policy ([#3503]). @@ -528,7 +578,7 @@ See also the [v0.107.6 GitHub milestone][ms-v0.107.6]. ### Security - `User-Agent` HTTP header removed from outgoing DNS-over-HTTPS requests. -- Go version was updated to prevent the possibility of exploiting the +- Go version has been updated to prevent the possibility of exploiting the [CVE-2022-24675], [CVE-2022-27536], and [CVE-2022-28327] Go vulnerabilities. ### Added @@ -583,7 +633,7 @@ were resolved. ### Security -- Go version was updated to prevent the possibility of exploiting the +- Go version has been updated to prevent the possibility of exploiting the [CVE-2022-24921] Go vulnerability. [CVE-2022-24921]: https://www.cvedetails.com/cve/CVE-2022-24921 @@ -596,7 +646,7 @@ See also the [v0.107.4 GitHub milestone][ms-v0.107.4]. ### Security -- Go version was updated to prevent the possibility of exploiting the +- Go version has been updated to prevent the possibility of exploiting the [CVE-2022-23806], [CVE-2022-23772], and [CVE-2022-23773] Go vulnerabilities. ### Fixed @@ -1333,11 +1383,12 @@ See also the [v0.104.2 GitHub milestone][ms-v0.104.2]. -[Unreleased]: https://github.com/AdguardTeam/AdGuardHome/compare/v0.107.15...HEAD +[Unreleased]: https://github.com/AdguardTeam/AdGuardHome/compare/v0.107.16...HEAD +[v0.107.16]: https://github.com/AdguardTeam/AdGuardHome/compare/v0.107.15...v0.107.16 [v0.107.15]: https://github.com/AdguardTeam/AdGuardHome/compare/v0.107.14...v0.107.15 [v0.107.14]: https://github.com/AdguardTeam/AdGuardHome/compare/v0.107.13...v0.107.14 [v0.107.13]: https://github.com/AdguardTeam/AdGuardHome/compare/v0.107.12...v0.107.13 diff --git a/Makefile b/Makefile index b4823bb7..cca89017 100644 --- a/Makefile +++ b/Makefile @@ -34,7 +34,7 @@ YARN_INSTALL_FLAGS = $(YARN_FLAGS) --network-timeout 120000 --silent\ --ignore-engines --ignore-optional --ignore-platform\ --ignore-scripts -V1API = 0 +NEXTAPI = 0 # Macros for the build-release target. If FRONTEND_PREBUILT is 0, the # default, the macro $(BUILD_RELEASE_DEPS_$(FRONTEND_PREBUILT)) expands @@ -63,7 +63,7 @@ ENV = env\ PATH="$${PWD}/bin:$$( "$(GO.MACRO)" env GOPATH )/bin:$${PATH}"\ RACE='$(RACE)'\ SIGN='$(SIGN)'\ - V1API='$(V1API)'\ + NEXTAPI='$(NEXTAPI)'\ VERBOSE='$(VERBOSE)'\ VERSION='$(VERSION)'\ diff --git a/README.md b/README.md index 43c9db89..1f2bc7a3 100644 --- a/README.md +++ b/README.md @@ -10,68 +10,76 @@ Free and open source, powerful network-wide ads & trackers blocking DNS server.

-

AdGuard.com | Wiki | Reddit | Twitter | Telegram -

+

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

- -
- +

- +

+
-
- -AdGuard Home is a network-wide software for blocking ads & 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 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. 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](https://adguard-dns.io/) servers, -and both share a lot of code. +software we use for our public [AdGuard DNS] servers, and both share a lot of +code. + +[AdGuard DNS]: https://adguard-dns.io/ -* [Getting Started](#getting-started) -* [Comparing AdGuard Home to other solutions](#comparison) - * [How is this different from public AdGuard DNS servers?](#comparison-adguard-dns) - * [How does AdGuard Home compare to Pi-Hole](#comparison-pi-hole) - * [How does AdGuard Home compare to traditional ad blockers](#comparison-adblock) -* [How to build from source](#how-to-build) -* [Contributing](#contributing) - * [Test unstable versions](#test-unstable-versions) - * [Reporting issues](#reporting-issues) - * [Help with translations](#translate) - * [Other](#help-other) -* [Projects that use AdGuard Home](#uses) -* [Acknowledgments](#acknowledgments) -* [Privacy](#privacy) + * [Getting Started](#getting-started) + * [Automated install (Unix)](#automated-install-linux-and-mac) + * [Alternative methods](#alternative-methods) + * [Guides](#guides) + * [API](#api) + * [Comparing AdGuard Home to other solutions](#comparison) + * [How is this different from public AdGuard DNS servers?](#comparison-adguard-dns) + * [How does AdGuard Home compare to Pi-Hole](#comparison-pi-hole) + * [How does AdGuard Home compare to traditional ad blockers](#comparison-adblock) + * [Known limitations](#comparison-limitations) + * [How to build from source](#how-to-build) + * [Prerequisites](#prerequisites) + * [Building](#building) + * [Contributing](#contributing) + * [Test unstable versions](#test-unstable-versions) + * [Reporting issues](#reporting-issues) + * [Help with translations](#translate) + * [Other](#help-other) + * [Projects that use AdGuard Home](#uses) + * [Acknowledgments](#acknowledgments) + * [Privacy](#privacy) - -## Getting Started -### Automated install (Linux and Mac) + +## Getting Started + + ### Automated install (Unix) Run the following command in your terminal: @@ -80,73 +88,96 @@ curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/s ``` The script also accepts some options: -* `-c ` to use specified channel. -* `-r` to reinstall AdGuard Home; -* `-u` to uninstall AdGuard Home; -* `-v` for verbose output; + + * `-c ` to use specified channel; + * `-r` to reinstall AdGuard Home; + * `-u` to uninstall AdGuard Home; + * `-v` for verbose output. Note that options `-r` and `-u` are mutually exclusive. -### Alternative methods -#### Manual installation -Please read the **[Getting Started](https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started)** article on our Wiki to learn how to install AdGuard Home manually, and how to configure your devices to use it. + ### Alternative methods -#### Docker + #### Manual installation -You can use our [official Docker image](https://hub.docker.com/r/adguard/adguardhome). +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. -#### Snap Store + #### Docker -If you're running **Linux**, there's a secure and easy way to install AdGuard Home - you can get it from the [Snap Store](https://snapcraft.io/adguard-home). +You can use our official Docker image on [Docker Hub]. -### Guides + #### Snap Store -* [Getting Started](https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started) - * [FAQ](https://github.com/AdguardTeam/AdGuardHome/wiki/FAQ) - * [How to Write Hosts Blocklists](https://github.com/AdguardTeam/AdGuardHome/wiki/Hosts-Blocklists) - * [Comparing AdGuard Home to Other Solutions](https://github.com/AdguardTeam/AdGuardHome/wiki/Comparison) -* Configuring AdGuard - * [Configuration](https://github.com/AdguardTeam/AdGuardHome/wiki/Configuration) - * [Configuring AdGuard Home Clients](https://github.com/AdguardTeam/AdGuardHome/wiki/Clients) - * [AdGuard Home as a DoH, DoT, or DoQ Server](https://github.com/AdguardTeam/AdGuardHome/wiki/Encryption) - * [AdGuard Home as a DNSCrypt Server](https://github.com/AdguardTeam/AdGuardHome/wiki/DNSCrypt) - * [AdGuard Home as a DHCP Server](https://github.com/AdguardTeam/AdGuardHome/wiki/DHCP) -* Installing AdGuard Home - * [Docker](https://github.com/AdguardTeam/AdGuardHome/wiki/Docker) - * [How to Install and Run AdGuard Home on a Raspberry Pi](https://github.com/AdguardTeam/AdGuardHome/wiki/Raspberry-Pi) - * [How to Install and Run AdGuard Home on a Virtual Private Server](https://github.com/AdguardTeam/AdGuardHome/wiki/VPS) -* [Verifying Releases](https://github.com/AdguardTeam/AdGuardHome/wiki/Verify-Releases) +If you're running **Linux,** there's a secure and easy way to install AdGuard +Home: get it from the [Snap Store]. -### API +[Docker Hub]: https://hub.docker.com/r/adguard/adguardhome +[Snap Store]: https://snapcraft.io/adguard-home +[wiki-start]: https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started -If you want to integrate with AdGuard Home, you can use our [REST API](https://github.com/AdguardTeam/AdGuardHome/tree/master/openapi). -Alternatively, you can use this [python client](https://pypi.org/project/adguardhome/), which is used to build the [AdGuard Home Hass.io Add-on](https://www.home-assistant.io/integrations/adguard/). - -## Comparing AdGuard Home to other solutions - -### How is this different from public AdGuard DNS servers? + ### Guides -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: +See our [Wiki][wiki]. -* Choose what exactly the server blocks and permits. -* Monitor your network activity. -* Add your own custom filtering rules. -* **Most importantly, this is your own server, and you are the only one who's in control.** +[wiki]: https://github.com/AdguardTeam/AdGuardHome/wiki - -### 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 "DNS sinkholing" method, and both allow customizing what's blocked. -> We're not going to stop here. DNS sinkholing is not a bad starting point, but this is just the beginning. + ### API -AdGuard Home provides a lot of features out-of-the-box with no need to install and configure additional software. We want it to be simple to the point when even casual users can set it up with minimal effort. +If you want to integrate with AdGuard Home, you can use our [REST API][openapi]. +Alternatively, you can use this [python client][pyclient], which is used to +build the [AdGuard Home Hass.io Add-on][hassio]. -> Disclaimer: some of the listed features can be added to Pi-Hole by installing additional software or by manually using SSH terminal and reconfiguring one of the utilities Pi-Hole consists of. However, in our opinion, this cannot be legitimately counted as a Pi-Hole's feature. +[hassio]: https://www.home-assistant.io/integrations/adguard/ +[openapi]: https://github.com/AdguardTeam/AdGuardHome/tree/master/openapi +[pyclient]: https://pypi.org/project/adguardhome/ + + + +## Comparing AdGuard Home to other solutions + + ### 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: + + * Choose what exactly the server blocks and permits. + + * Monitor your network activity. + + * Add your own custom filtering rules. + + * **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 + +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. + + + +AdGuard Home provides a lot of features out-of-the-box with no need to install +and configure additional software. We want it to be simple to the point when +even casual users can set it up with minimal effort. + +**Disclaimer:** some of the listed features can be added to Pi-Hole by +installing additional software or by manually using SSH terminal and +reconfiguring one of the utilities Pi-Hole consists of. However, in our +opinion, this cannot be legitimately counted as a Pi-Hole's feature. | Feature | AdGuard Home | Pi-Hole | |-------------------------------------------------------------------------|-------------------|-----------------------------------------------------------| @@ -162,53 +193,72 @@ AdGuard Home provides a lot of features out-of-the-box with no need to install a | Force Safe search on search engines | ✅ | ❌ | | Per-client (device) configuration | ✅ | ✅ | | Access settings (choose who can use AGH DNS) | ✅ | ❌ | -| Running [without root privileges](https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started#running-without-superuser) | ✅ | ❌ | +| Running [without root privileges][wiki-noroot] | ✅ | ❌ | - -### How does AdGuard Home compare to traditional ad blockers +[wiki-noroot]: https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started#running-without-superuser + + + + ### How does AdGuard Home compare to traditional ad blockers It depends. -“DNS sinkholing” is capable of blocking a big percentage of ads, but it lacks -flexibility and power of traditional ad blockers. You can get a good impression -about the difference between these methods by reading -[this article](https://adguard.com/en/blog/adguard-vs-adaway-dns66/). It -compares AdGuard for Android (a traditional ad blocker) to hosts-level ad -blockers (which are almost identical to DNS-based blockers in their -capabilities). This level of protection is enough for some users. +DNS sinkholing is capable of blocking a big percentage of ads, but it lacks +the flexibility and the power of traditional ad blockers. You can get a good +impression about the difference between these methods by reading [this +article][blog-adaway], which compares AdGuard for Android (a traditional ad +blocker) to hosts-level ad blockers (which are almost identical to DNS-based +blockers in their capabilities). This level of protection is enough for some +users. + +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). -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 + * YouTube, Twitch ads; -Essentially, any advertising that shares a domain with content cannot be blocked by a DNS-level blocker. + * Facebook, Twitter, Instagram sponsored posts. -Is there a chance to handle this in the future? DNS will never be enough to do this. Our only option is to use a content blocking proxy like what we do in the standalone AdGuard applications. We're [going to bring](https://github.com/AdguardTeam/AdGuardHome/issues/1228) this feature support to AdGuard Home in the future. Unfortunately, even in this case, there still will be cases when this won't be enough or would require quite a complicated configuration. +Essentially, any advertising that shares a domain with content cannot be blocked +by a DNS-level blocker. - -## How to build from source +Is there a chance to handle this in the future? DNS will never be enough to do +this. Our only option is to use a content blocking proxy like what we do in the +standalone AdGuard applications. We're [going to bring][issue-1228] this +feature support to AdGuard Home in the future. Unfortunately, even in this +case, there still will be cases when this won't be enough or would require quite +a complicated configuration. -### Prerequisites +[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 + + ### Prerequisites Run `make init` to prepare the development environment. You will need this to build AdGuard Home: - * [go](https://golang.org/dl/) v1.18 or later. - * [node.js](https://nodejs.org/en/download/) v10.16.2 or later. - * [npm](https://www.npmjs.com/) v6.14 or later (temporary requirement, TODO: remove when redesign is finished). - * [yarn](https://yarnpkg.com/) v1.22.5 or later. + * [Go](https://golang.org/dl/) v1.18 or later; + * [Node.js](https://nodejs.org/en/download/) v10.16.2 or later; + * [npm](https://www.npmjs.com/) v6.14 or later; + * [yarn](https://yarnpkg.com/) v1.22.5 or later. -### Building -Open Terminal and execute these commands: + + ### Building + +Open your terminal and execute these commands: ```sh git clone https://github.com/AdguardTeam/AdGuardHome @@ -216,16 +266,18 @@ cd AdGuardHome make ``` -Please note, that the non-standard `-j` flag is currently not supported, so -building with `make -j 4` or setting your `MAKEFLAGS` to include, for example, -`-j 4` is likely to break the build. If you do have your `MAKEFLAGS` set to -that, and you don't want to change it, you can override it by running -`make -j 1`. +**NOTE:** The non-standard `-j` flag is currently not supported, so building +with `make -j 4` or setting your `MAKEFLAGS` to include, for example, `-j 4` is +likely to break the build. If you do have your `MAKEFLAGS` set to that, and you +don't want to change it, you can override it by running `make -j 1`. -Check the [`Makefile`](https://github.com/AdguardTeam/AdGuardHome/blob/master/Makefile) to learn about other commands. +Check the [`Makefile`][src-makefile] to learn about other commands. -**Building for a different platform.** You can build AdGuard for any OS/ARCH just like any other Go project. -In order to do this, specify `GOOS` and `GOARCH` env variables before running make. + #### 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`. For example: @@ -239,168 +291,223 @@ or: make GOOS='linux' GOARCH='arm64' ``` -#### Preparing release + #### Preparing releases -You'll need this to prepare a release build: - -* [snapcraft](https://snapcraft.io/) - -Commands: +You'll need [`snapcraft`] to prepare a release build. Once installed, run the +following command: ```sh make build-release CHANNEL='...' VERSION='...' ``` -#### Docker image +See the [`build-release` target documentation][targ-release]. -* Run `make build-docker` to build the Docker image locally (the one that we publish to DockerHub). + #### Docker image -Please note, that we're using [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) to build our official 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. You may need to prepare before using these builds: -* (Linux-only) Install Qemu: `docker run --rm --privileged multiarch/qemu-user-static --reset -p yes --credential yes` -* Prepare builder: `docker buildx create --name buildx-builder --driver docker-container --use` + * (Linux-only) Install Qemu: + + ```sh + docker run --rm --privileged multiarch/qemu-user-static --reset -p yes --credential yes + ``` + + * Prepare the builder: + + ```sh + docker buildx create --name buildx-builder --driver docker-container --use + ``` + +See the [`build-docker` target documentation][targ-docker]. + + #### 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. + +1. In a separate terminal, run: + + ```sh + ( cd ./client/ && env NODE_ENV='development' npm run watch ) + ``` + +2. Run your `AdGuardHome` binary with the `--local-frontend` flag, which + instructs AdGuard Home to ignore the built-in frontend files and use those + from the `./build/` directory. + +3. Now any changes you make in the `./client/` directory should be recompiled + and become available on the web UI. Make sure that you disable the browser + cache to make sure that you actually get the recompiled version. + +[`snapcraft`]: https://snapcraft.io/ +[buildx]: https://docs.docker.com/buildx/working-with-buildx/ +[src-makefile]: https://github.com/AdguardTeam/AdGuardHome/blob/master/Makefile +[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 -### Resources that we update periodically -* `scripts/translations` -* `scripts/whotracksme` +## 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. -You are welcome to fork this repository, make your changes and submit a pull request — https://github.com/AdguardTeam/AdGuardHome/pulls +Please note that we don't expect people to contribute to both UI and backend +parts of the program simultaneously. Ideally, the backend part is implemented +first, i.e. configuration, API, and the functionality itself. The UI part can +be implemented later in a different pull request by a different person. -Please note that we don't expect people to contribute to both UI and golang parts of the program simultaneously. Ideally, the golang part is implemented first, i.e. configuration, API, and the functionality itself. The UI part can be implemented later in a different pull request by a different person. +[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: -* `beta` - beta version of AdGuard Home. More or less stable versions. -* `edge` - the newest version of AdGuard Home. New updates are pushed to this channel daily and it is the closest to the master branch you can get. + * `beta`: beta versions of AdGuard Home. More or less stable versions, + usually released every two weeks or more often. + + * `edge`: the newest version of AdGuard Home from the development branch. New + updates are pushed to this channel daily. There are three options how you can install an unstable version: -1. [Snap Store](https://snapcraft.io/adguard-home) -- look for "beta" and "edge" channels there. -2. [Docker Hub](https://hub.docker.com/r/adguard/adguardhome) -- look for "beta" and "edge" tags there. -3. Standalone builds. Use the automated installation script or look for the available builds below. +1. [Snap Store]: look for the `beta` and `edge` channels. -Beta: +2. [Docker Hub]: look for the `beta` and `edge` tags. -```sh -curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c beta -``` +3. Standalone builds. Use the automated installation script or look for the + available builds [on the Wiki][wiki-platf]. -Edge: + Script to install a beta version: -```sh -curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c edge -``` + ```sh + curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c beta + ``` - * Beta channel builds - * Linux: [64-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_amd64.tar.gz), [32-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_386.tar.gz) - * Linux ARM: [32-bit ARMv6](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_armv6.tar.gz) (recommended for Raspberry Pi OS stable), [64-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_arm64.tar.gz), [32-bit ARMv5](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_armv5.tar.gz), [32-bit ARMv7](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_armv7.tar.gz) - * Linux MIPS: [32-bit MIPS](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_mips_softfloat.tar.gz), [32-bit MIPSLE](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_mipsle_softfloat.tar.gz), [64-bit MIPS](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_mips64_softfloat.tar.gz), [64-bit MIPSLE](https://static.adtidy.org/adguardhome/beta/AdGuardHome_linux_mips64le_softfloat.tar.gz) - * Windows: [64-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_windows_amd64.zip), [32-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_windows_386.zip) - * macOS: [64-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_darwin_amd64.zip), [32-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_darwin_386.zip) - * macOS ARM: [64-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_darwin_arm64.zip) - * FreeBSD: [64-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_freebsd_amd64.tar.gz), [32-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_freebsd_386.tar.gz) - * FreeBSD ARM: [64-bit](https://static.adtidy.org/adguardhome/beta/AdGuardHome_freebsd_arm64.tar.gz), [32-bit ARMv5](https://static.adtidy.org/adguardhome/beta/AdGuardHome_freebsd_armv5.tar.gz), [32-bit ARMv6](https://static.adtidy.org/adguardhome/beta/AdGuardHome_freebsd_armv6.tar.gz), [32-bit ARMv7](https://static.adtidy.org/adguardhome/beta/AdGuardHome_freebsd_armv7.tar.gz) - * OpenBSD: (coming soon) - * OpenBSD ARM: (coming soon) + Script to install an edge version: - * Edge channel builds - * Linux: [64-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_amd64.tar.gz), [32-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_386.tar.gz) - * Linux ARM: [32-bit ARMv6](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_armv6.tar.gz) (recommended for Raspberry Pi OS stable), [64-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_arm64.tar.gz), [32-bit ARMv5](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_armv5.tar.gz), [32-bit ARMv7](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_armv7.tar.gz) - * Linux MIPS: [32-bit MIPS](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_mips_softfloat.tar.gz), [32-bit MIPSLE](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_mipsle_softfloat.tar.gz), [64-bit MIPS](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_mips64_softfloat.tar.gz), [64-bit MIPSLE](https://static.adtidy.org/adguardhome/edge/AdGuardHome_linux_mips64le_softfloat.tar.gz) - * Windows: [64-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_windows_amd64.zip), [32-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_windows_386.zip) - * macOS: [64-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_darwin_amd64.zip), [32-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_darwin_386.zip) - * macOS ARM: [64-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_darwin_arm64.zip) - * FreeBSD: [64-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_freebsd_amd64.tar.gz), [32-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_freebsd_386.tar.gz) - * FreeBSD ARM: [64-bit](https://static.adtidy.org/adguardhome/edge/AdGuardHome_freebsd_arm64.tar.gz), [32-bit ARMv5](https://static.adtidy.org/adguardhome/edge/AdGuardHome_freebsd_armv5.tar.gz), [32-bit ARMv6](https://static.adtidy.org/adguardhome/edge/AdGuardHome_freebsd_armv6.tar.gz), [32-bit ARMv7](https://static.adtidy.org/adguardhome/edge/AdGuardHome_freebsd_armv7.tar.gz) - * OpenBSD: [64-bit (experimental)](https://static.adtidy.org/adguardhome/edge/AdGuardHome_openbsd_amd64.tar.gz) - * OpenBSD ARM: [64-bit (experimental)](https://static.adtidy.org/adguardhome/edge/AdGuardHome_openbsd_arm64.tar.gz) + ```sh + curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c edge + ``` +[wiki-platf]: https://github.com/AdguardTeam/AdGuardHome/wiki/Platforms - -### Report issues -If you run into any problem or have a suggestion, head to [this page](https://github.com/AdguardTeam/AdGuardHome/issues) and click on the `New issue` button. + ### Report issues - -### Help with translations +If you run into any problem or have a suggestion, head to [this page][iss] and +click on the “New issue” button. + +[iss]: https://github.com/AdguardTeam/AdGuardHome/issues + + + + ### Help with translations If you want to help with AdGuard Home translations, please learn more about -translating AdGuard products -[in our Knowledge Base](https://kb.adguard.com/en/general/adguard-translations). +translating AdGuard products [in our Knowledge Base][kb-trans]. You can +contribute to the [AdGuardHome project on CrowdIn][crowdin]. -Here is a link to AdGuard Home project: - +[crowdin]: https://crowdin.com/project/adguard-applications/en#/adguard-home +[kb-trans]: https://kb.adguard.com/en/general/adguard-translations - -### Other -Here's what you can also do to contribute: -1. [Look for issues][helpissues] marked as "help wanted". -2. Actualize the list of *Blocked services*. It can be found in - [filtering/blocked.go][blocked.go]. -3. Actualize the list of known *trackers*. It it can be found in [this repo] - [companiesdb]. -4. Actualize the list of vetted *blocklists*. It it can be found in - [client/src/helpers/filters/filters.json][filters.json]. + ### Other -[helpissues]: https://github.com/AdguardTeam/AdGuardHome/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+ -[blocked.go]: https://github.com/AdguardTeam/AdGuardHome/blob/master/internal/filtering/blocked.go -[companiesdb]: https://github.com/AdguardTeam/companiesdb -[filters.json]: https://github.com/AdguardTeam/AdGuardHome/blob/master/client/src/helpers/filters/filters.json +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. - -## Projects that use AdGuard Home +[iss-help]: https://github.com/AdguardTeam/AdGuardHome/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 -* [AdGuard Home Remote](https://apps.apple.com/app/apple-store/id1543143740) - iOS app by [Joost](https://rocketscience-it.nl/) -* [Python library](https://github.com/frenck/python-adguardhome) by [@frenck](https://github.com/frenck) -* [Home Assistant add-on](https://github.com/hassio-addons/addon-adguard-home) by [@frenck](https://github.com/frenck) -* [OpenWrt LUCI app](https://github.com/kongfl888/luci-app-adguardhome) by [@kongfl888](https://github.com/kongfl888) (originally by [@rufengsuixing](https://github.com/rufengsuixing)) -* [Prometheus exporter for AdGuard Home](https://github.com/ebrianne/adguard-exporter) by [@ebrianne](https://github.com/ebrianne) -* [AdGuard Home on GLInet routers](https://forum.gl-inet.com/t/adguardhome-on-gl-routers/10664) by [Gl-Inet](https://gl-inet.com/) -* [Cloudron app](https://git.cloudron.io/cloudron/adguard-home-app) by [@gramakri](https://github.com/gramakri) -* [Asuswrt-Merlin-AdGuardHome-Installer](https://github.com/jumpsmm7/Asuswrt-Merlin-AdGuardHome-Installer) by [@jumpsmm7](https://github.com/jumpsmm7) aka [@SomeWhereOverTheRainBow](https://www.snbforums.com/members/somewhereovertherainbow.64179/) -* [Node.js library](https://github.com/Andrea055/AdguardHomeAPI) by [@Andrea055](https://github.com/Andrea055/) - -## Acknowledgments + +## Projects that use AdGuard Home + + + + * [AdGuard Home Remote](https://apps.apple.com/app/apple-store/id1543143740): + iOS app by [Joost](https://rocketscience-it.nl/). + + * [Python library](https://github.com/frenck/python-adguardhome) by + [@frenck](https://github.com/frenck). + + * [Home Assistant add-on](https://github.com/hassio-addons/addon-adguard-home) + by [@frenck](https://github.com/frenck). + + * [OpenWrt LUCI app](https://github.com/kongfl888/luci-app-adguardhome) by + [@kongfl888](https://github.com/kongfl888) (originally by + [@rufengsuixing](https://github.com/rufengsuixing)). + + * [Prometheus exporter for AdGuard + Home](https://github.com/ebrianne/adguard-exporter) by + [@ebrianne](https://github.com/ebrianne). + + * [AdGuard Home on GLInet + routers](https://forum.gl-inet.com/t/adguardhome-on-gl-routers/10664) by + [Gl-Inet](https://gl-inet.com/). + + * [Cloudron app](https://git.cloudron.io/cloudron/adguard-home-app) by + [@gramakri](https://github.com/gramakri). + + * [Asuswrt-Merlin-AdGuardHome-Installer](https://github.com/jumpsmm7/Asuswrt-Merlin-AdGuardHome-Installer) + by [@jumpsmm7](https://github.com/jumpsmm7) aka + [@SomeWhereOverTheRainBow](https://www.snbforums.com/members/somewhereovertherainbow.64179/). + + * [Node.js library](https://github.com/Andrea055/AdguardHomeAPI) by + [@Andrea055](https://github.com/Andrea055/). + + + +## Acknowledgments + + This software wouldn't have been possible without: - * [Go](https://golang.org/dl/) and its libraries: - * [gcache](https://github.com/bluele/gcache) - * [miekg's dns](https://github.com/miekg/dns) - * [go-yaml](https://github.com/go-yaml/yaml) - * [service](https://godoc.org/github.com/kardianos/service) - * [dnsproxy](https://github.com/AdguardTeam/dnsproxy) - * [urlfilter](https://github.com/AdguardTeam/urlfilter) - * [Node.js](https://nodejs.org/) and its libraries: - * [React.js](https://reactjs.org) - * [Tabler](https://github.com/tabler/tabler) - * And many more node.js packages. - * [whotracks.me data](https://github.com/cliqz-oss/whotracks.me) + * [Go](https://golang.org/dl/) and its libraries: + * [gcache](https://github.com/bluele/gcache) + * [miekg's dns](https://github.com/miekg/dns) + * [go-yaml](https://github.com/go-yaml/yaml) + * [service](https://godoc.org/github.com/kardianos/service) + * [dnsproxy](https://github.com/AdguardTeam/dnsproxy) + * [urlfilter](https://github.com/AdguardTeam/urlfilter) + * [Node.js](https://nodejs.org/) and its libraries: + * And many more Node.js packages. + * [React.js](https://reactjs.org) + * [Tabler](https://github.com/tabler/tabler) + * [whotracks.me data](https://github.com/cliqz-oss/whotracks.me) -You might have seen that [CoreDNS](https://coredns.io) was mentioned here -before, but we've stopped using it in AdGuard Home. +You might have seen that [CoreDNS] was mentioned here before, but we've stopped +using it in AdGuard Home. -For a full list of all node.js packages in use, please take a look at [client/package.json](https://github.com/AdguardTeam/AdGuardHome/blob/master/client/package.json) file. +For the full list of all Node.js packages in use, please take a look at +[`client/package.json`][src-packagejson] file. - -## Privacy +[CoreDNS]: https://coredns.io +[src-packagejson]: https://github.com/AdguardTeam/AdGuardHome/blob/master/client/package.json + +## 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. Full policy -with every bit that *could in theory be* sent by AdGuard Home is available -[here](https://adguard.com/en/privacy/home.html) +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 diff --git a/bamboo-specs/release.yaml b/bamboo-specs/release.yaml index ddd95734..4232b734 100644 --- a/bamboo-specs/release.yaml +++ b/bamboo-specs/release.yaml @@ -7,7 +7,7 @@ # Make sure to sync any changes with the branch overrides below. 'variables': 'channel': 'edge' - 'dockerGo': 'adguard/golang-ubuntu:5.1' + 'dockerGo': 'adguard/golang-ubuntu:5.2' 'stages': - 'Build frontend': @@ -322,7 +322,7 @@ # need to build a few of these. 'variables': 'channel': 'beta' - 'dockerGo': 'adguard/golang-ubuntu:5.1' + 'dockerGo': 'adguard/golang-ubuntu:5.2' # release-vX.Y.Z branches are the branches from which the actual final release # is built. - '^release-v[0-9]+\.[0-9]+\.[0-9]+': @@ -337,4 +337,4 @@ # are the ones that actually get released. 'variables': 'channel': 'release' - 'dockerGo': 'adguard/golang-ubuntu:5.1' + 'dockerGo': 'adguard/golang-ubuntu:5.2' diff --git a/bamboo-specs/test.yaml b/bamboo-specs/test.yaml index fe26bd10..81796e1f 100644 --- a/bamboo-specs/test.yaml +++ b/bamboo-specs/test.yaml @@ -5,7 +5,7 @@ 'key': 'AHBRTSPECS' 'name': 'AdGuard Home - Build and run tests' 'variables': - 'dockerGo': 'adguard/golang-ubuntu:5.1' + 'dockerGo': 'adguard/golang-ubuntu:5.2' 'stages': - 'Tests': diff --git a/client/src/__locales/en.json b/client/src/__locales/en.json index e059c9f4..b986dea1 100644 --- a/client/src/__locales/en.json +++ b/client/src/__locales/en.json @@ -215,6 +215,7 @@ "example_upstream_udp": "regular DNS (over UDP, hostname);", "example_upstream_dot": "encrypted <0>DNS-over-TLS;", "example_upstream_doh": "encrypted <0>DNS-over-HTTPS;", + "example_upstream_doh3": "encrypted DNS-over-HTTPS with forced <0>HTTP/3 and no fallback to HTTP/2 or below;", "example_upstream_doq": "encrypted <0>DNS-over-QUIC;", "example_upstream_sdns": "<0>DNS Stamps for <1>DNSCrypt or <2>DNS-over-HTTPS resolvers;", "example_upstream_tcp": "regular DNS (over TCP);", @@ -605,7 +606,7 @@ "blocklist": "Blocklist", "milliseconds_abbreviation": "ms", "cache_size": "Cache size", - "cache_size_desc": "DNS cache size (in bytes).", + "cache_size_desc": "DNS cache size (in bytes). To disable caching, leave empty.", "cache_ttl_min_override": "Override minimum TTL", "cache_ttl_max_override": "Override maximum TTL", "enter_cache_size": "Enter cache size (bytes)", diff --git a/client/src/components/Logs/Cells/ClientCell.js b/client/src/components/Logs/Cells/ClientCell.js index 669f1c0a..9467f14e 100644 --- a/client/src/components/Logs/Cells/ClientCell.js +++ b/client/src/components/Logs/Cells/ClientCell.js @@ -121,7 +121,7 @@ const ClientCell = ({ {options.map(({ name, onClick, disabled }) => ( ; const blockClientButton =