Add Docusaurus frontmatter and improve documentation structure
- Add sidebar_position to all documentation files (1-15) - Add "Configuration Reference" section to README.md with links to: - Container Labels - Environment Variables - Volumes - Other Configurations - Limitations - Ensure sidebar_position values match README.md link order exactly - Order follows logical flow: Platform installation → Tool installation → Special topics → Configuration reference - All documentation now properly configured for Docusaurus
This commit is contained in:
parent
58eea44929
commit
96120d4554
16 changed files with 70 additions and 0 deletions
10
README.md
10
README.md
|
|
@ -80,6 +80,16 @@ If you already set up the EasyHAProxy, is time to go deeper:
|
||||||
- [Custom SSL](docs/ssl.md)
|
- [Custom SSL](docs/ssl.md)
|
||||||
- [Automatic Certificate Issuing](docs/acme.md) (e.g. Letsencrypt)
|
- [Automatic Certificate Issuing](docs/acme.md) (e.g. Letsencrypt)
|
||||||
|
|
||||||
|
## Configuration Reference
|
||||||
|
|
||||||
|
Detailed configuration guides for advanced setups:
|
||||||
|
|
||||||
|
- [Container Labels](docs/container-labels.md) - Configure Docker/Swarm containers with labels
|
||||||
|
- [Environment Variables](docs/environment-variable.md) - Configure EasyHAProxy behavior
|
||||||
|
- [Volumes](docs/volumes.md) - Map volumes for certificates, config, and custom files
|
||||||
|
- [Other Configurations](docs/other.md) - Additional configurations (ports, custom errors, etc.)
|
||||||
|
- [Limitations](docs/limitations.md) - Important limitations and considerations
|
||||||
|
|
||||||
## See EasyHAProxy in action
|
## See EasyHAProxy in action
|
||||||
|
|
||||||
Click on the image to see the videos (use HD for better visualization)
|
Click on the image to see the videos (use HD for better visualization)
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 10
|
||||||
|
---
|
||||||
|
|
||||||
# SSL - Automatic Certificate Management Environment (ACME)
|
# SSL - Automatic Certificate Management Environment (ACME)
|
||||||
|
|
||||||
The Automatic Certificate Management Environment (ACME) protocol
|
The Automatic Certificate Management Environment (ACME) protocol
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 11
|
||||||
|
---
|
||||||
|
|
||||||
# Container Labels
|
# Container Labels
|
||||||
|
|
||||||
## Container (Docker or Swarm) labels
|
## Container (Docker or Swarm) labels
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 8
|
||||||
|
---
|
||||||
|
|
||||||
# DigitalOcean
|
# DigitalOcean
|
||||||
|
|
||||||
DigitalOcean is a cloud infrastructure provider focused on simplifying web infrastructure for software developers.
|
DigitalOcean is a cloud infrastructure provider focused on simplifying web infrastructure for software developers.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
# Docker
|
# Docker
|
||||||
|
|
||||||
## Setup Docker EasyHAProxy
|
## Setup Docker EasyHAProxy
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 7
|
||||||
|
---
|
||||||
|
|
||||||
# Dokku
|
# Dokku
|
||||||
|
|
||||||
Dokku is a Docker powered mini-Heroku in around 100 lines of Bash. It is the smallest PaaS implementation you've ever seen, weighing in at a little over 100 MB of memory usage and about 80 MB of disk space.
|
Dokku is a Docker powered mini-Heroku in around 100 lines of Bash. It is the smallest PaaS implementation you've ever seen, weighing in at a little over 100 MB of memory usage and about 80 MB of disk space.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 12
|
||||||
|
---
|
||||||
|
|
||||||
# Docker environment variables
|
# Docker environment variables
|
||||||
|
|
||||||
| Environment Variable | Description | Default |
|
| Environment Variable | Description | Default |
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 5
|
||||||
|
---
|
||||||
|
|
||||||
# Helm 3
|
# Helm 3
|
||||||
|
|
||||||
Helm is a package manager for Kubernetes. It allows you to install and manage applications on Kubernetes.
|
Helm is a package manager for Kubernetes. It allows you to install and manage applications on Kubernetes.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
# Kubernetes
|
# Kubernetes
|
||||||
|
|
||||||
## Setup Kubernetes EasyHAProxy
|
## Setup Kubernetes EasyHAProxy
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 15
|
||||||
|
---
|
||||||
|
|
||||||
# Limitations and Considerations
|
# Limitations and Considerations
|
||||||
|
|
||||||
## EasyHAProxy will not work with --network=host
|
## EasyHAProxy will not work with --network=host
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 6
|
||||||
|
---
|
||||||
|
|
||||||
# Microk8s Add-ons
|
# Microk8s Add-ons
|
||||||
|
|
||||||
Microk8s is a lightweight Kubernetes distribution that can run on a single machine. It is very easy to install and use.
|
Microk8s is a lightweight Kubernetes distribution that can run on a single machine. It is very easy to install and use.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 14
|
||||||
|
---
|
||||||
|
|
||||||
# Other configurations
|
# Other configurations
|
||||||
|
|
||||||
## Exposing Ports
|
## Exposing Ports
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 9
|
||||||
|
---
|
||||||
|
|
||||||
# Setup custom certificates
|
# Setup custom certificates
|
||||||
|
|
||||||
You can use your own certificates with EasyHAProxy. You just need to let EasyHAProxy know that certificate.
|
You can use your own certificates with EasyHAProxy. You just need to let EasyHAProxy know that certificate.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 4
|
||||||
|
---
|
||||||
|
|
||||||
# Static File
|
# Static File
|
||||||
|
|
||||||
## Setup Docker EasyHAProxy
|
## Setup Docker EasyHAProxy
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
# Swarm
|
# Swarm
|
||||||
|
|
||||||
## Setup Docker EasyHAProxy
|
## Setup Docker EasyHAProxy
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
sidebar_position: 13
|
||||||
|
---
|
||||||
|
|
||||||
# Volumes
|
# Volumes
|
||||||
|
|
||||||
You can map the following volumes:
|
You can map the following volumes:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue