mirrors
/
AdGuardHome
mirror of https://github.com/AdguardTeam/AdGuardHome.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Pull request 2128: 6585-imp-readme 

Closes #6585.

Squashed commit of the following:

commit 903079b2c91ce84e66c368565808251dcf7a16a6
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Jan 15 17:48:51 2024 +0300

    all: fix typo

commit 232083a8b29d030758c2db91f26c214cdd8cfc93
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Jan 15 17:45:24 2024 +0300

    all: imp docs
This commit is contained in:
Stanislav Chzhen 2024-01-15 20:16:26 +03:00
parent 1e0ff4d437
commit 58b47adaff
2 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CHANGELOG.md
View File

@ -41,11 +41,14 @@ NOTE: Add new changes BELOW THIS COMMENT.
#### Configuration changes
In this release, the schema version has changed from 27 to 28.
- The new property `clients.persistent.*.uid`, which is unique identifier of the
persistent client.
- The properties `dns.'all_servers` and `dns.fastest_addr` were removed, their
- The properties `dns.all_servers` and `dns.fastest_addr` were removed, their
values migrated to newly added field `dns.upstream_mode` that describes the
logic through which upstreams will be used.
logic through which upstreams will be used. See also a [Wiki
page][wiki-config].
```yaml
# BEFORE:
@ -60,6 +63,10 @@ NOTE: Add new changes BELOW THIS COMMENT.
'upstream_mode': 'parallel'
```
To rollback this change, remove the new field `upstream_mode`, set back
`dns.all_servers` and `dns.fastest_addr` properties in `dns` section, and
change the `schema_version` back to `27`.
### Fixed
- Zero value in `querylog.size_memory` disables logging ([#6570]).
@ -85,6 +92,8 @@ NOTE: Add new changes BELOW THIS COMMENT.
[#6574]: https://github.com/AdguardTeam/AdGuardHome/issues/6574
[#6584]: https://github.com/AdguardTeam/AdGuardHome/issues/6584
[wiki-config]: https://github.com/AdguardTeam/AdGuardHome/wiki/Configuration
<!--
NOTE: Add new changes ABOVE THIS COMMENT.
-->

9
README.md
View File

@ -276,6 +276,15 @@ Open your terminal and execute these commands:
git clone https://github.com/AdguardTeam/AdGuardHome
cd AdGuardHome
make
```
#### <a href="#building-node" id="building-node" name="building-node">Building with Node.js 17 and later</a>
In order to build AdGuard Home with Node.js 17 and later, specify
`--openssl-legacy-provider` option.
```sh
export NODE_OPTIONS=--openssl-legacy-provider
```
**NOTE:** The non-standard `-j` flag is currently not supported, so building