diff --git a/README.md b/README.md index e66b7d0..a74c2af 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,16 @@ If you already set up the EasyHAProxy, is time to go deeper: - [Custom SSL](docs/ssl.md) - [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 Click on the image to see the videos (use HD for better visualization) diff --git a/docs/acme.md b/docs/acme.md index 8e43d3e..a92d3eb 100644 --- a/docs/acme.md +++ b/docs/acme.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 10 +--- + # SSL - Automatic Certificate Management Environment (ACME) The Automatic Certificate Management Environment (ACME) protocol diff --git a/docs/container-labels.md b/docs/container-labels.md index fea51a8..443de2f 100644 --- a/docs/container-labels.md +++ b/docs/container-labels.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 11 +--- + # Container Labels ## Container (Docker or Swarm) labels diff --git a/docs/digitalocean.md b/docs/digitalocean.md index ff1edec..de48e9f 100644 --- a/docs/digitalocean.md +++ b/docs/digitalocean.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 8 +--- + # DigitalOcean DigitalOcean is a cloud infrastructure provider focused on simplifying web infrastructure for software developers. diff --git a/docs/docker.md b/docs/docker.md index ffa139c..f3eae41 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 3 +--- + # Docker ## Setup Docker EasyHAProxy diff --git a/docs/dokku.md b/docs/dokku.md index a8c2e25..9b5490c 100644 --- a/docs/dokku.md +++ b/docs/dokku.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 7 +--- + # 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. diff --git a/docs/environment-variable.md b/docs/environment-variable.md index 661438d..ab841af 100644 --- a/docs/environment-variable.md +++ b/docs/environment-variable.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 12 +--- + # Docker environment variables | Environment Variable | Description | Default | diff --git a/docs/helm.md b/docs/helm.md index ae35f59..9a9b28a 100644 --- a/docs/helm.md +++ b/docs/helm.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 5 +--- + # Helm 3 Helm is a package manager for Kubernetes. It allows you to install and manage applications on Kubernetes. diff --git a/docs/kubernetes.md b/docs/kubernetes.md index 4305df1..3bc9e71 100644 --- a/docs/kubernetes.md +++ b/docs/kubernetes.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # Kubernetes ## Setup Kubernetes EasyHAProxy diff --git a/docs/limitations.md b/docs/limitations.md index 309ea52..da77984 100644 --- a/docs/limitations.md +++ b/docs/limitations.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 15 +--- + # Limitations and Considerations ## EasyHAProxy will not work with --network=host diff --git a/docs/microk8s.md b/docs/microk8s.md index b4880f5..2d5c9ad 100644 --- a/docs/microk8s.md +++ b/docs/microk8s.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 6 +--- + # Microk8s Add-ons Microk8s is a lightweight Kubernetes distribution that can run on a single machine. It is very easy to install and use. diff --git a/docs/other.md b/docs/other.md index 37fea53..6466a0a 100644 --- a/docs/other.md +++ b/docs/other.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 14 +--- + # Other configurations ## Exposing Ports diff --git a/docs/ssl.md b/docs/ssl.md index 9b49e0c..d4c13a3 100644 --- a/docs/ssl.md +++ b/docs/ssl.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 9 +--- + # Setup custom certificates You can use your own certificates with EasyHAProxy. You just need to let EasyHAProxy know that certificate. diff --git a/docs/static.md b/docs/static.md index 4f7c3a1..ab03363 100644 --- a/docs/static.md +++ b/docs/static.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # Static File ## Setup Docker EasyHAProxy diff --git a/docs/swarm.md b/docs/swarm.md index 5c0b8c2..ec93886 100644 --- a/docs/swarm.md +++ b/docs/swarm.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Swarm ## Setup Docker EasyHAProxy diff --git a/docs/volumes.md b/docs/volumes.md index 47daa02..945ef17 100644 --- a/docs/volumes.md +++ b/docs/volumes.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 13 +--- + # Volumes You can map the following volumes: