1
0
Fork 0

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:
Claude 2025-11-09 23:50:44 +00:00
parent 96120d4554
commit aee9645b43
No known key found for this signature in database
13 changed files with 140 additions and 105 deletions

View file

@ -13,9 +13,9 @@ There are two ways to do that.
## Setup certificate as a label definition in docker container
1. Create a single PEM from the certificate and key.
1. Create a single PEM from the certificate and key.
```bash
```bash title="Combine certificate and key"
cat example.com.crt example.com.key > single.pem
cat single.pem
@ -33,7 +33,7 @@ MIIEojCCA4qgAwIBAgIUegW2BimwuL4RzRZ2WYkHA6U5nkAwDQYJKoZIhvcNAQEL
2. Convert the `single.pem` to BASE64 in a single line:
```bash
```bash title="Convert to BASE64"
cat single.pem | base64 -w0
```
@ -47,7 +47,7 @@ EasyHAProxy stores the certificates inside the container folder `/certs/haproxy`
1. Run EasyHAProxy with the volume for the certificates:
```bash
```bash title="Create and mount certificate volume"
docker volume create certs_haproxy
docker run \
@ -58,7 +58,7 @@ docker run \
2. Create a single PEM from the certificate and the key.
```bash
```bash title="Combine certificate and key"
cat example.com.crt example.com.key > single.pem
cat single.pem
@ -74,9 +74,9 @@ MIIEojCCA4qgAwIBAgIUegW2BimwuL4RzRZ2WYkHA6U5nkAwDQYJKoZIhvcNAQEL
-----END PRIVATE KEY-----
```
3. Copy this certificate to EasyHAProxy volume
3. Copy this certificate to EasyHAProxy volume:
```bash
```bash title="Copy certificate to container"
docker cp single.pem easyhaproxy:/certs/haproxy
```