Joao Gilberto Magalhaes ae6eb1b55a Add detailed plugin documentation for Cleanup, Cloudflare, Deny Pages, IP Whitelist, JWT Validator, and FastCGI plugins

- Added individual markdown files with examples, configuration options, and HAProxy outputs for each plugin.
- Updated `README.md` to link plugin-specific documentation.
- Enhanced `plugins.md` to summarize plugin features and usage.
- Included Docker, Kubernetes, Swarm, and static configuration examples for all plugins.

2025-12-01 13:36:11 -05:00

1.9 KiB

Raw Blame History

Cleanup Plugin

Type: Global Plugin Runs: Once per discovery cycle

Overview

The Cleanup plugin performs cleanup tasks during each discovery cycle, such as removing old temporary files.

Why Use It

Prevents disk space issues by automatically cleaning up temporary files created by EasyHAProxy.

Configuration Options

Option	Description	Default
`enabled`	Enable/disable plugin	`true`
`max_idle_time`	Maximum age in seconds before deleting files	`300`
`cleanup_temp_files`	Enable temp file cleanup	`true`

Configuration Examples

Static YAML Configuration

# /etc/haproxy/static/config.yaml
plugins:
  enabled: [cleanup]
  config:
    cleanup:
      max_idle_time: 600
      cleanup_temp_files: true

Environment Variables

EASYHAPROXY_PLUGINS_ENABLED=cleanup
EASYHAPROXY_PLUGIN_CLEANUP_MAX_IDLE_TIME=600

Custom Idle Time (1 hour)

# /etc/haproxy/static/config.yaml
plugins:
  enabled: [cleanup]
  config:
    cleanup:
      enabled: true
      max_idle_time: 3600  # 1 hour

How It Works

The cleanup plugin:

Runs once during each discovery cycle
Scans temporary directories for old files
Removes files older than max_idle_time seconds
Helps maintain disk space efficiency

Important Notes

This is a global plugin - it runs once per discovery cycle, not per domain
Does not generate HAProxy configuration
Performs maintenance operations in the background
Safe to enable in production environments

1.9 KiB Raw Blame History