Joao Gilberto Magalhaes b4944ac544 Add use_builtin_ips support and reorganize plugin documentation

- Enhanced Cloudflare Plugin with `use_builtin_ips` option to automatically use and update built-in IP ranges.
- Updated Cloudflare IP restoration logic, including metadata and HAProxy config generation.
- Reorganized plugin documentation with sidebar positions for improved accessibility.
- Extended Cloudflare documentation to detail built-in IP ranges, examples, and configurations.
- Added new test cases to validate `use_builtin_ips` functionality and file handling.

2025-12-01 18:00:52 -05:00

1.9 KiB

Raw Blame History

sidebar_position
6

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