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

Pull request: Configuration: clients 

Merge in GO/adguard-home-wiki from custom-ups-cache to master

Squashed commit of the following:

commit 05f652777a4a60243873910e0395aba0eb067a23
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Mon Nov 13 11:22:18 2023 +0200

    Configuration: clients
Dimitry Kolyshev 2023-11-17 16:04:50 +03:00
parent 3081c32be0
commit 5967378fab
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Configuration.md

@ -819,9 +819,31 @@ Settings are stored in [YAML format](https://en.wikipedia.org/wiki/YAML), possib
- `rlimit_nofile` — Limit on the maximum number of open files for the server - `rlimit_nofile` — Limit on the maximum number of open files for the server
process (on unixlike OSs). Set to `0` to use the system's default value. process (on unixlike OSs). Set to `0` to use the system's default value.
- **Clients settings** - **Clients settings**
- `clients` — Persistent and runtime clients settings. - `clients`: Persistent and runtime clients settings.
- `persistent` — An array of explicitly configured clients. **Before - `persistent`: An array of explicitly configured clients. **Before
v0.108.0** the contents of this field took up the whole `clients` section. v0.108.0** the contents of this field took up the whole `clients` section.
Each client has the following properties:
- `safe_search`: Safe search settings section.
- `blocked_services`: Blocked services settings section.
- `name`: Client's name.
- `ids`: List of client's identifiers.
- `tags`: List of client's tags.
- `upstreams`: Upstreams configuration.
- `upstreams_cache_size`: **Since v0.107.41** client's cache size.
- `upstreams_cache_enabled`: **Since v0.107.41** if client's cache is
enabled.
- `use_global_settings`: Shows if the client-specific settings are used to
override the global settings.
- `filtering_enabled`: Indicates whether or not to use filter lists.
- `parental_enabled`: Indicates whether or not to use parental protection.
- `safebrowsing_enabled`: Indicates whether or not to use safe browsing
protection.
- `use_global_blocked_services`: Shows if the client-specific settings are
used to override the global Blocked Services settings.
- `ignore_querylog`: Indicates whether or not to exclude client's activity
from the query log.
- `ignore_statistics`: Indicates whether or not to exclude client's
activity from the statistics.
- `runtime_sources` — **Since v0.108.0** this controls the certain runtime - `runtime_sources` — **Since v0.108.0** this controls the certain runtime
clients sources. clients sources.
- `whois` — Request WHOIS information for clients with public IP - `whois` — Request WHOIS information for clients with public IP