diff --git a/docs/Plugins/cleanup.md b/docs/Plugins/cleanup.md index 76ac12d..d1d9ef4 100644 --- a/docs/Plugins/cleanup.md +++ b/docs/Plugins/cleanup.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 21 --- # Cleanup Plugin diff --git a/docs/Plugins/cloudflare.md b/docs/Plugins/cloudflare.md index ff6bf66..8949c1e 100644 --- a/docs/Plugins/cloudflare.md +++ b/docs/Plugins/cloudflare.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 18 --- # Cloudflare Plugin diff --git a/docs/Plugins/deny-pages.md b/docs/Plugins/deny-pages.md index 0d7cff8..9c9bf2c 100644 --- a/docs/Plugins/deny-pages.md +++ b/docs/Plugins/deny-pages.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 20 --- # Deny Pages Plugin diff --git a/docs/Plugins/fastcgi.md b/docs/Plugins/fastcgi.md index aa1316d..28db516 100644 --- a/docs/Plugins/fastcgi.md +++ b/docs/Plugins/fastcgi.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 17 --- # FastCGI Plugin @@ -174,4 +174,4 @@ The plugin configures: ## Related Documentation - [Plugin System Overview](../plugins.md) -- [Container Labels Reference](../container-labels.md) \ No newline at end of file +- [Container Labels Reference](../container-labels.md) diff --git a/docs/Plugins/ip-whitelist.md b/docs/Plugins/ip-whitelist.md index 0cc6132..2ae8f15 100644 --- a/docs/Plugins/ip-whitelist.md +++ b/docs/Plugins/ip-whitelist.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 19 --- # IP Whitelist Plugin diff --git a/docs/Plugins/jwt-validator.md b/docs/Plugins/jwt-validator.md index 4e192f1..1b419ea 100644 --- a/docs/Plugins/jwt-validator.md +++ b/docs/Plugins/jwt-validator.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 16 --- # JWT Validator Plugin diff --git a/docs/environment-variable.md b/docs/environment-variable.md index 8b52806..e591616 100644 --- a/docs/environment-variable.md +++ b/docs/environment-variable.md @@ -11,14 +11,18 @@ sidebar_position: 12 | EASYHAPROXY_CERTBOT_* | (Optional) Enable Let's Encrypt or any other ACME certificate. See more: [acme](acme.md) | *empty* | | EASYHAPROXY_SSL_MODE | (Optional) `strict` supports only the most recent TLS version; `default` good SSL integration with recent browsers; `loose` supports all old SSL protocols for old browsers (not recommended). | `default` | | EASYHAPROXY_REFRESH_CONF | (Optional) Check for new containers/services every N seconds. | 10 | -| EASYHAPROXY_LOG_LEVEL | (Optional) The log level for EasyHAproxy messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL | INFO | +| EASYHAPROXY_LOG_LEVEL | (Optional) The log level for EasyHAproxy messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL | DEBUG | | CERTBOT_LOG_LEVEL | (Optional) The log level for Certbot messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL | DEBUG | -| HAPROXY_LOG_LEVEL | (Optional) The log level for HAProxy messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL | DEBUG | -| HAPROXY_USERNAME | (Optional) The HAProxy username to the statistics. | `admin` | -| HAPROXY_PASSWORD | (Optional) The HAProxy password to the statistics. If not set, statistics will be available with no password | *empty* | -| HAPROXY_STATS_PORT | (Optional) The HAProxy port to the statistics. If set to `false`, disable statistics | `1936` | +| HAPROXY_LOG_LEVEL | (Optional) The log level for HAProxy messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL | INFO | +| HAPROXY_USERNAME | (Optional) The HAProxy username for the statistics endpoint (used only when `HAPROXY_PASSWORD` is set). | `admin` | +| HAPROXY_PASSWORD | (Optional) The HAProxy password to the statistics endpoint. Stats are **disabled** unless this is defined. | *empty* | +| HAPROXY_STATS_PORT | (Optional) The HAProxy port to the statistics. If set to `false`, disable statistics. Only applies when `HAPROXY_PASSWORD` is defined. | `1936` | | HAPROXY_CUSTOMERRORS | (Optional) If HAProxy will use custom HTML errors. true/false. | `false` | +:::tip HAProxy Stats +Statistics are only configured when `HAPROXY_PASSWORD` is set. Without a password, the stats section is not generated. +::: + :::note ACME/Certbot Environment Variables For ACME/Certbot configuration (Let's Encrypt, ZeroSSL, etc.), see the [ACME documentation](acme.md#environment-variables) for the complete list of `EASYHAPROXY_CERTBOT_*` variables. ::: diff --git a/docs/limitations.md b/docs/limitations.md index 53c2549..9d3bba7 100644 --- a/docs/limitations.md +++ b/docs/limitations.md @@ -1,5 +1,5 @@ --- -sidebar_position: 15 +sidebar_position: 23 --- # Limitations and Considerations @@ -35,4 +35,4 @@ If you need to run multiple replicas for high availability, **do not activate AC ::: ---- -[Open source ByJG](http://opensource.byjg.com) \ No newline at end of file +[Open source ByJG](http://opensource.byjg.com) diff --git a/docs/other.md b/docs/other.md index f376e13..cc45282 100644 --- a/docs/other.md +++ b/docs/other.md @@ -1,5 +1,5 @@ --- -sidebar_position: 14 +sidebar_position: 22 --- # Other configurations @@ -9,7 +9,7 @@ sidebar_position: 14 Some ports on the EasyHAProxy container and in the firewall are required to be open. However, you don't need to expose the other container ports because EasyHAProxy will handle that. - The ports `80` and `443`. -- If you enable the HAProxy statistics, you must also expose the port defined in `HAPROXY_STATS_PORT` environment variable (default 1936). Be aware that statistics are enabled by default with no password. +- If you enable the HAProxy statistics, you must also expose the port defined in `HAPROXY_STATS_PORT` environment variable (default 1936). Statistics are only generated when you set `HAPROXY_PASSWORD`. - Every port defined in `easyhaproxy.[definitions].port` also should be exposed. For example: @@ -51,4 +51,4 @@ If enabled, map the volume : `/etc/haproxy/errors-custom/` to your container and where ERROR_NUMBER is the HTTP error code (e.g., `503.http`) ---- -[Open source ByJG](http://opensource.byjg.com) \ No newline at end of file +[Open source ByJG](http://opensource.byjg.com) diff --git a/docs/plugin-development.md b/docs/plugin-development.md index 54be8cd..f017f0c 100644 --- a/docs/plugin-development.md +++ b/docs/plugin-development.md @@ -1,5 +1,5 @@ --- -sidebar_position: 17 +sidebar_position: 15 --- # Plugin Development Guide diff --git a/docs/plugins.md b/docs/plugins.md index 3feedfd..9adda9a 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -1,5 +1,5 @@ --- -sidebar_position: 16 +sidebar_position: 14 --- # Using Plugins