aljaz/addons
1
0
Fork 0
mirror of https://github.com/aljazceru/addons.git synced 2025-12-17 05:04:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for the cloudflare flag (#795)

Browse Source 
Also delete-trailing-whitespace.
This commit is contained in:
Sharif Nassar
2019-10-20 03:24:53 -07:00
committed by Pascal Vizeli
parent a980fdfa54
commit f834647518
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
nginx_proxy/README.md
View File

@@ -48,13 +48,14 @@ Add-on configuration:
"active": false,
"default": "nginx_proxy_default*.conf",
"servers": "nginx_proxy/*.conf"
}
},
"cloudflare": false
}
```
### Option: `domain` (required)
The domain name to use for the proxy.
The domain name to use for the proxy.
### Option: `certfile` (required)
@@ -62,7 +63,7 @@ The certificate file to use in the `/ssl` directory. Keep filename as-is if you
### Option: `keyfile` (required)
Private key file to use in the `/ssl` directory.
Private key file to use in the `/ssl` directory.
### Option: `hsts` (required)
@@ -80,9 +81,14 @@ The filename of the NGINX configuration for the default server, found in the `/s
The filename(s) of the NGINX configuration for the additional servers, found in the `/share` directory.
### Option `cloudflare` (optional)
If enabled, configure Nginx with a list of IP addresses directly from Cloudflare that will be used for `set_real_ip_from` directive Nginx config.
This is so the `ip_ban_enabled` feature can be used and work correctly in /config/customize.yaml.
## Known issues and limitations
- By default, port 80 is disabled in the add-on configuration in case the port is needed for other components or add-ons like `emulated_hue`.
- By default, port 80 is disabled in the add-on configuration in case the port is needed for other components or add-ons like `emulated_hue`.
## Support