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
|
|
@ -16,19 +16,20 @@ To accomplish this, EasyHAProxy may need to attach the same network to its conta
|
|||
|
||||
It's recommended to create a network external to EasyHAProxy, although it's not mandatory.
|
||||
|
||||
Limitations:
|
||||
- You cannot mix Docker containers with Swarm containers.
|
||||
- This method does not work with containers that use the '--network=host' option. (see [limitations](limitations.md))
|
||||
:::warning Limitations
|
||||
- You cannot mix Docker containers with Swarm containers.
|
||||
- This method does not work with containers that use the `--network=host` option. See [limitations](limitations.md) for details.
|
||||
:::
|
||||
|
||||
e.g.:
|
||||
For example:
|
||||
|
||||
```bash
|
||||
```bash title="Create EasyHAProxy network"
|
||||
docker network create easyhaproxy
|
||||
```
|
||||
|
||||
And then run the EasyHAProxy
|
||||
And then run the EasyHAProxy:
|
||||
|
||||
```bash
|
||||
```bash title="Run EasyHAProxy container"
|
||||
docker run -d \
|
||||
--name easy-haproxy-container \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
|
|
@ -45,9 +46,9 @@ Mapping to `/var/run/docker.sock` is necessary to discover the docker containers
|
|||
|
||||
## Running containers
|
||||
|
||||
To make your containers "discoverable" by EasyHAProxy, that is the minimum configuration you need:
|
||||
To make your containers "discoverable" by EasyHAProxy, this is the minimum configuration you need:
|
||||
|
||||
```bash
|
||||
```bash title="Run container with EasyHAProxy labels"
|
||||
docker run -d \
|
||||
--label easyhaproxy.http.host=example.org \
|
||||
--label easyhaproxy.http.port=80 \
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue