Enhance documentation with Docusaurus features and fix inaccuracies
Verified against source code and enhanced with Docusaurus markdown features: Documentation Accuracy Fixes: - Fixed acme.md: Added "letsencrypt" as valid AUTOCONFIG value (was incorrectly shown as "-") - Added reference to ACME docs from environment-variable.md - Verified all features against actual implementation in /src Docusaurus Enhancements Added: - Admonitions (:::note, :::tip, :::warning, :::danger, :::info) for important callouts - Code block titles for all bash/yaml examples (e.g., title="Install EasyHAProxy") - Better structured warnings and notes for limitations - Improved formatting and readability throughout Files Enhanced: - kubernetes.md: Added info boxes, warnings, code titles - docker.md: Added limitation warnings, code titles - swarm.md: Added advantage tips, limitation warnings - acme.md: Fixed Let's Encrypt autoconfig, enhanced requirements with admonitions - ssl.md: Added code block titles for all examples - static.md: Added live reload tip, SSL certificate note - container-labels.md: Added definition explanation, code titles - limitations.md: Restructured with clear warnings and explanations - helm.md: Added warnings, code titles - microk8s.md: Added ingress controller warning, code titles - volumes.md: Added info box about volume purposes - other.md: Added code block titles - environment-variable.md: Added ACME reference note All changes verified against actual Python source code implementation.
This commit is contained in:
parent
96120d4554
commit
aee9645b43
13 changed files with 140 additions and 105 deletions
|
|
@ -21,24 +21,26 @@ sidebar_position: 11
|
|||
| easyhaproxy.[definition].clone_to_ssl | (Optional) It copies the configuration to HTTPS(443) and disable SSL from the current config. **Do not use* this with `ssl` or `certbot` parameters | false | true OR false |
|
||||
| easyhaproxy.[definition].balance | (Optional) HAProxy balance algorithm. See [HAProxy documentation](https://cbonte.github.io/haproxy-dconv/1.8/configuration.html#4.2-balance) | roundrobin | roundrobin, source, uri, url_param, hdr, rdp-cookie, leastconn, first, static-rr, rdp-cookie, hdr_dom, map-based |
|
||||
|
||||
The `definition` is a string that will group all configurations togethers. Different `definition` will create different configurations.
|
||||
:::info Understanding Definitions
|
||||
The `[definition]` is a string identifier that groups related configuration labels together. Different definitions create separate HAProxy configurations.
|
||||
|
||||
The container can have more than one definition.
|
||||
A single container can have multiple definitions to expose different services or ports.
|
||||
:::
|
||||
|
||||
## Configuations
|
||||
|
||||
### Single Definition
|
||||
|
||||
```bash
|
||||
```bash title="Single service configuration"
|
||||
docker run \
|
||||
--label easyhaproxy.webapi.port=80\
|
||||
--label easyhaproxy.webapi.host=byjg.com.br \
|
||||
....
|
||||
```
|
||||
|
||||
### Multiples Definitions on the same container
|
||||
### Multiple Definitions on the same container
|
||||
|
||||
```bash
|
||||
```bash title="Multiple services on one container"
|
||||
docker run \
|
||||
--label easyhaproxy.express.port=80 \
|
||||
--label easyhaproxy.express.localport=3000 \
|
||||
|
|
@ -51,9 +53,9 @@ docker run \
|
|||
some/myimage
|
||||
```
|
||||
|
||||
### Multiples hosts on the same container
|
||||
### Multiple hosts on the same container
|
||||
|
||||
```bash
|
||||
```bash title="Multiple hosts for one service"
|
||||
docker run \
|
||||
--label easyhaproxy.express.port=80 \
|
||||
--label easyhaproxy.express.localport=3000 \
|
||||
|
|
@ -80,9 +82,9 @@ services:
|
|||
|
||||
### TCP Mode
|
||||
|
||||
Set `easyhaproxy.[definition].mode=tcp` if your application uses TCP protocol instead of HTTP.
|
||||
Set `easyhaproxy.[definition].mode=tcp` if your application uses TCP protocol instead of HTTP.
|
||||
|
||||
```bash
|
||||
```bash title="TCP mode configuration"
|
||||
docker run \
|
||||
--label easyhaproxy.example.mode=tcp \
|
||||
--label easyhaproxy.example.port=3306
|
||||
|
|
@ -93,7 +95,7 @@ docker run \
|
|||
|
||||
### Redirect Domains
|
||||
|
||||
```bash
|
||||
```bash title="Domain redirect configuration"
|
||||
docker run \
|
||||
--label easyhaproxy.[definition].redirect='{"www.byjg.com.br":"http://byjg.com.br","byjg.com":"http://byjg.com.br"}'
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue