Documentation Refactor

2026-02-20 01:05:37 -05:00 · 2026-02-20 01:05:37 -05:00 · a410b34521
commit a410b34521
parent 3b8818e636
47 changed files with 2065 additions and 3911 deletions
--- a/docs/reference/plugins/cloudflare.md
+++ b/docs/reference/plugins/cloudflare.md
@ -0,0 +1,120 @@
+---
+sidebar_position: 3
+sidebar_label: "Cloudflare"
+---
+
+# Cloudflare Plugin
+
+**Type:** Domain Plugin
+**Runs:** Once for each discovered domain/host
+
+## Overview
+
+The Cloudflare plugin restores the original visitor IP address when requests come through Cloudflare's CDN. The plugin includes **built-in Cloudflare IP ranges** that are automatically written to the IP list file - no manual configuration required!
+
+## Why Use It
+
+Cloudflare replaces the visitor's IP with its own. This plugin restores the original IP from the `CF-Connecting-IP` header.
+
+## Configuration Options
+
+| Option            | Description                              | Default                               |
+|-------------------|------------------------------------------|---------------------------------------|
+| `enabled`         | Enable/disable plugin                    | `true`                                |
+| `use_builtin_ips` | Use built-in Cloudflare IP ranges        | `true`                                |
+| `ip_list_path`    | Path to Cloudflare IP list               | `/etc/easyhaproxy/cloudflare_ips.lst` |
+
+## Configuration Examples
+
+### Docker/Docker Compose (Basic - Uses Built-in IPs)
+
+```yaml
+services:
+  myapp:
+    labels:
+      easyhaproxy.http.host: example.com
+      easyhaproxy.http.plugins: cloudflare
+# Built-in Cloudflare IPs are automatically used - no additional configuration needed!
+```
+
+### Docker/Docker Compose (Custom IP List)
+
+```yaml
+labels:
+  easyhaproxy.http.plugins: cloudflare
+  easyhaproxy.http.plugin.cloudflare.use_builtin_ips: false
+  easyhaproxy.http.plugin.cloudflare.ip_list_path: /custom/path/cf_ips.lst
+```
+
+### Kubernetes Annotations
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  annotations:
+    easyhaproxy.plugins: "cloudflare"
+    easyhaproxy.plugin.cloudflare.ip_list_path: "/etc/easyhaproxy/cloudflare_ips.lst"
+spec:
+  rules:
+    - host: example.com
+      http:
+        paths:
+          - path: /
+            backend:
+              service:
+                name: myapp
+                port:
+                  number: 80
+```
+
+### Static YAML Configuration
+
+```yaml
+plugins:
+  config:
+    cloudflare:
+      enabled: true
+      use_builtin_ips: true  # Uses built-in Cloudflare IPs (default)
+```
+
+### Environment Variables
+
+| Environment Variable                            | Config Key        | Type     | Default                               | Description                           |
+|-------------------------------------------------|-------------------|----------|---------------------------------------|---------------------------------------|
+| `EASYHAPROXY_PLUGIN_CLOUDFLARE_ENABLED`         | `enabled`         | boolean  | `true`                                | Enable/disable plugin for all domains |
+| `EASYHAPROXY_PLUGIN_CLOUDFLARE_USE_BUILTIN_IPS` | `use_builtin_ips` | boolean  | `true`                                | Use built-in Cloudflare IP ranges     |
+| `EASYHAPROXY_PLUGIN_CLOUDFLARE_IP_LIST_PATH`    | `ip_list_path`    | string   | `/etc/easyhaproxy/cloudflare_ips.lst` | Path to Cloudflare IP list file       |
+
+## Generated HAProxy Configuration
+
+```haproxy
+# Cloudflare - Restore original visitor IP
+acl from_cloudflare src -f /etc/easyhaproxy/cloudflare_ips.lst
+http-request set-header X-Forwarded-For %[req.hdr(CF-Connecting-IP)] if from_cloudflare
+```
+
+## Built-in Cloudflare IP Ranges
+
+The plugin includes the current Cloudflare IP ranges (22 ranges total):
+
+**IPv4 Ranges (15):**
+- 173.245.48.0/20, 103.21.244.0/22, 103.22.200.0/22, 103.31.4.0/22
+- 141.101.64.0/18, 108.162.192.0/18, 190.93.240.0/20, 188.114.96.0/20
+- 197.234.240.0/22, 198.41.128.0/17, 162.158.0.0/15, 104.16.0.0/13
+- 104.24.0.0/14, 172.64.0.0/13, 131.0.72.0/22
+
+**IPv6 Ranges (7):**
+- 2400:cb00::/32, 2606:4700::/32, 2803:f800::/32, 2405:b500::/32
+- 2405:8100::/32, 2a06:98c0::/29, 2c0f:f248::/32
+
+## Important Notes
+
+- ✅ **No manual configuration required** - Built-in Cloudflare IPs are included!
+- The plugin runs once per domain during the discovery cycle
+- IP list file is automatically created and updated
+
+## Related Documentation
+
+- [Plugin System Overview](../../guides/plugins.md)
+- [Container Labels Reference](../container-labels.md)