badblocks/docker-easy-haproxy
1
0
Fork 0
Code Activity

Reorganize documentation sidebar positions and update HAProxy stats configuration

Browse source 
- Updated sidebar positions across multiple documentation files for improved navigation and logical grouping.
- Revised HAProxy stats configuration to require `HAPROXY_PASSWORD` for enabling statistics.
- Clarified environment variable descriptions and usage in `environment-variable.md`.
This commit is contained in:
Joao Gilberto Magalhaes 2025-12-04 11:27:18 -05:00
parent 3c7ef2d2a8
commit 525e1b170d
11 changed files with 23 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/Plugins/cleanup.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 6 sidebar_position: 21
--- ---
# Cleanup Plugin # Cleanup Plugin

2
docs/Plugins/cloudflare.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 5 sidebar_position: 18
--- ---
# Cloudflare Plugin # Cloudflare Plugin

2
docs/Plugins/deny-pages.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 4 sidebar_position: 20
--- ---
# Deny Pages Plugin # Deny Pages Plugin

2
docs/Plugins/fastcgi.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 1 sidebar_position: 17
--- ---
# FastCGI Plugin # FastCGI Plugin

2
docs/Plugins/ip-whitelist.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 3 sidebar_position: 19
--- ---
# IP Whitelist Plugin # IP Whitelist Plugin

2
docs/Plugins/jwt-validator.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 2 sidebar_position: 16
--- ---
# JWT Validator Plugin # JWT Validator Plugin

14
docs/environment-variable.md
View file

@ -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_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_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_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 | | 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_LOG_LEVEL | (Optional) The log level for HAProxy messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL | INFO |
| HAPROXY_USERNAME | (Optional) The HAProxy username to the statistics. | `admin` | | 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. If not set, statistics will be available with no password | *empty* | | 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 | `1936` | | 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` | | 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 :::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. 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.
::: :::

2
docs/limitations.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 15 sidebar_position: 23
--- ---
# Limitations and Considerations # Limitations and Considerations

4
docs/other.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 14 sidebar_position: 22
--- ---
# Other configurations # 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. 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`. - 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. - Every port defined in `easyhaproxy.[definitions].port` also should be exposed.
For example: For example:

2
docs/plugin-development.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 17 sidebar_position: 15
--- ---
# Plugin Development Guide # Plugin Development Guide

2
docs/plugins.md
View file

@ -1,5 +1,5 @@
--- ---
sidebar_position: 16 sidebar_position: 14
--- ---
# Using Plugins # Using Plugins