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

Pull request: http-yaml-conf 

Squashed commit of the following:

commit 4ae421abdbea52e831b4b721954298d150be4e81
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Jun 28 09:45:50 2023 +0400

    Configuration: imp docs

commit 3fe6556ffef06200be29e91b76e004b81c9a0f62
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Jun 27 16:03:45 2023 +0400

    Configuration: imp docs

commit 9175aca2d09ead8bfab49db8285b30cd3a133237
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Jun 27 14:56:31 2023 +0400

    Configuration: imp docs

commit 1ba79e4370b3a7de6f5c47ecbba61ed32df9d978
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Jun 27 10:32:30 2023 +0400

    Configuration: imp docs

commit b155e3a3b89165dde631ed43396d6c8299c3e797
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Tue Jun 27 10:29:08 2023 +0400

    Configuration: http object

commit 10689c5d06ce724017855cf8172b884d9aba7f0a
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Mon Jun 26 12:06:36 2023 +0400

    Configuration: http object
Dimitry Kolyshev 2023-06-29 15:30:49 +03:00
parent 5d05d042e2
commit 2acda96b08
2 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Configuration.md

@ -312,19 +312,26 @@ Upon the first execution, a file named `AdGuardHome.yaml` will be created, with
Settings are stored in [YAML format](https://en.wikipedia.org/wiki/YAML), possible parameters that you can configure are listed below:
- `bind_host` — Web interface IP address to listen on.
- `bind_port` — Web interface IP port to listen on.
- `users` — Web users info
- `name` — User name
- `password` — BCrypt-encrypted password
- `auth_attempts` (**after v0.106.0**) – Maximum number of failed login attempts
- `bind_host` (**before v0.107.33**): Web interface IP address to listen on.
- `bind_port` (**before v0.107.33**): Web interface IP port to listen on.
- `http` (**since v0.107.33**): Web interface configuration.
- `address`: Web interface IP address with port to listen on.
- `session_ttl`: Web session TTL is a time duration in a human-readable
format. The web user will stay signed in for this amount of time.
- `users`: Web users info.
- `name`: User name.
- `password`: BCrypt-encrypted password.
- `auth_attempts` (**after v0.106.0**): Maximum number of failed login attempts
a user can do before being blocked. The entire blocking logic is disabled if
it equals to 0.
- `block_auth_min` (**after v0.106.0**) – The duration of blocking period. The
- `block_auth_min` (**after v0.106.0**): The duration of blocking period. The
entire blocking logic is disabled if it equals to 0.
- `http_proxy` — Proxy URL for HTTP client (e.g. "http://user:password@server:port/"). Supports "http", "https" and "socks5" scheme.
- `web_session_ttl` — Web session TTL (in hours) - a web user will stay signed in for this amount of time.
- `debug_pprof` — Enable pprof HTTP server listening on port 6060 for debugging. See section `Profiling with pprof`.
- `http_proxy`: Proxy URL for HTTP client, e.g. `http://user:password@server:port/`.
Supports `http`, `https` and `socks5` schemes.
- `web_session_ttl` (**before v0.107.33**): Web session TTL (in hours), a web
user will stay signed in for this amount of time.
- `debug_pprof`: Enable pprof HTTP server listening on port 6060 for debugging.
See section `Profiling with pprof`.
- `dns` — DNS configuration section.
- **General settings**

10
FAQ.md

@ -223,13 +223,13 @@ edit the configuration file manually:
1. Open `AdGuardHome.yaml` in your editor.
1. Set the `bind_host` setting to a new network interface. For example:
1. Set the `http.address` setting to a new network interface. For example:
* `0.0.0.0` to listen on all network interfaces.
* `0.0.0.0:0` to listen on all network interfaces.
* `0.0.0.0:8080` to listen on all network interfaces with port `8080`.
* `127.0.0.1` to listen on the local loopback interface only.
1. Optionally, set the `bind_port` setting to set a new port.
* `127.0.0.1:0` to listen on the local loopback interface only.
1. Restart AdGuard Home: