diff --git a/docs/2-configuration.md b/docs/2-configuration.md index 73e1022e..f22b4b8c 100644 --- a/docs/2-configuration.md +++ b/docs/2-configuration.md @@ -30,7 +30,7 @@ Here's what you can configure: | Environment Variable | CLI Flag | Config File Path | Required | Default (docker) | Description | | ------------------------------------ | ----------------------------------- | ------------------------------ | -------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `WG_CONFIG` | `--config` | | | | The path to a wg-access-server config.yaml file | -| `WG_LOG_LEVEL` | `--log-level` | `logLevel` | | `info` | The global log level | +| `WG_LOG_LEVEL` | `--log-level` | `loglevel` | | `info` | The global log level | | `WG_ADMIN_USERNAME` | `--admin-username` | `adminUsername` | | `admin` | The admin account username | | `WG_ADMIN_PASSWORD` | `--admin-password` | `adminPassword` | Yes | | The admin account password | | `WG_PORT` | `--port` | `port` | | `8000` | The port the web ui will listen on (http) | @@ -55,9 +55,9 @@ Here's what you can configure: | `WG_DNS_ENABLED` | `--[no-]dns-enabled` | `dns.enabled` | | `true` | Enable/disable the embedded DNS proxy server. This is enabled by default and allows VPN clients to avoid DNS leaks by sending all DNS requests to wg-access-server itself. | | `WG_DNS_UPSTREAM` | `--dns-upstream` | `dns.upstream` | | _resolvconf autodetection or Cloudflare DNS_ | The upstream DNS servers to proxy DNS requests to. By default the host machine's resolveconf configuration is used to find its upstream DNS server, with a fallback to Cloudflare. | | `WG_DNS_DOMAIN` | `--dns-domain` | `dns.domain` | | | A domain to serve configured devices authoritatively. Queries for names in the format .. will be answered with the device's IP addresses. | -| `WG_CLIENTCONFIG_DNS_SERVERS` | `--clientconfig-dns-servers` | `clientconfig.dnsservers` | | | DNS servers (one or more IP addresses) to write into the client configuration file. Are used instead of the servers DNS settings, if set. | -| `WG_CLIENTCONFIG_DNS_SEARCH_DOMAIN` | `--clientconfig-dns-search-domain` | `clientconfig.dnssearchdomain` | | | DNS search domain to write into the client configuration file. | -| `WG_CLIENTCONFIG_MTU` | `--clientconfig-mtu` | `clientconfig.mtu` | | | The maximum transmission unit (MTU) to write into the client configuration file. If left empty, a sensible default is used. | +| `WG_CLIENTCONFIG_DNS_SERVERS` | `--clientconfig-dns-servers` | `clientConfig.dnsServers` | | | DNS servers (one or more IP addresses) to write into the client configuration file. Are used instead of the servers DNS settings, if set. | +| `WG_CLIENTCONFIG_DNS_SEARCH_DOMAIN` | `--clientconfig-dns-search-domain` | `clientConfig.dnsSearchDomain` | | | DNS search domain to write into the client configuration file. | +| `WG_CLIENTCONFIG_MTU` | `--clientconfig-mtu` | `clientConfig.mtu` | | | The maximum transmission unit (MTU) to write into the client configuration file. If left empty, a sensible default is used. | ## The Config File (config.yaml)