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

Enhance documentation with Docusaurus features and fix inaccuracies

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

18
docs/microk8s.md
View file

@ -13,9 +13,9 @@ Here are the steps to install EasyHAProxy on your Microk8s.
EasyHAProxy is being part of official MicroK8s Community edition since MicroK8s version 1.27.
Just enable the community add-on
Just enable the community add-on:
```
```bash title="Enable community addons"
microk8s enable community
```
@ -34,7 +34,7 @@ addons:
However, if you are using MicroK8s before 1.27 you need to enable it directly from the ByJG repository by accessing the microk8s host machine and run:
```shell
```bash title="Add ByJG addon repository"
microk8s addons repo add byjg https://github.com/byjg/microk8s-addons.git
```
@ -58,19 +58,21 @@ Once you have enable the EasyHAProxy from the community repository or from ByJG
Usage:
Install as a Daemonset
Install as a Daemonset:
```shell
```bash title="Install as DaemonSet"
microk8s enable easyhaproxy
```
Install as a NodePort
Install as a NodePort:
```shell
```bash title="Install as NodePort"
microk8s enable easyhaproxy --nodeport
```
**Remember**: you need to disable any ingress controller you have previously installed, for example, nginx, traefik, etc. before install EasyHaProxy.
:::warning Disable Other Ingress Controllers
You need to disable any ingress controller you have previously installed (e.g., nginx, traefik, etc.) before installing EasyHAProxy to avoid conflicts.
:::
For more parameters you can refer to the [Kubernetes](kubernetes.md) page.