Table of contents

• Release Notes
• Getting Started
  • Hardware Recommendations
  • System Tuning
  • Installation
    • BSD
    • Docker
    • Kubernetes
    • Linux
  • Additional Packages
  • Upgrade
    • Linux
    • BSD
    • Docker
    • Community to Enterprise
• Configuration
  • Configuration Section Basics
    • Overview
    • Global
    • Frontend
    • Backend
    • Listen
    • Defaults
    • Userlist
    • Cache
    • Http-errors
    • Mailers
    • Resolvers
    • Fcgi-app
    • Peers
    • Aggregations
    • Program
    • Dynamic-update
  • Binds
    • Overview
    • Syntax
    • Bind Reference
  • Servers
    • Overview
    • Syntax
    • Server Reference
  • Fetches
    • Overview
    • Syntax
    • Fetch Reference
  • ACLs
    • Overview
    • Syntax
    • Inline ACLs
    • Predefined ACLs
    • ACL Reference
  • Converters
    • Overview
    • Converter Reference
  • Map Files
    • Overview
    • Syntax
  • Stick Tables
    • Overview
    • Syntax
    • Stick Table Reference
  • Variables
    • Overview
    • Syntax
    • Environment Variables
  • Reference Manual
• Management
  • Start/Stop the Service
  • Ansible
  • Multi-threading
  • Dynamic Data Updates
    • Installation
    • TLS session ticket keys
    • Update Module Reference
  • DNS Service Discovery
    • Discovery with A Records
    • Discovery with SRV Records
  • Real Time Dashboard
    • Installation
    • Lua Module
    • Dashboard Gateway
    • Using the Dashboard
  • Enable/Disable Servers
• High Availability
  • Active/Active Clustering
    • Layer 4 Load Balancing
    • DNS Round-robin
    • Route Health Injection
    • Realtime cluster-wide tracking
      • Overview
      • Installation
      • Single-level setup
      • Multi-level setup
      • Highly-available setup
      • Display aggregated data
      • Configure CPU affinity
      • Bind outgoing connections
      • Encrypt traffic
      • Manage the service
      • Troubleshooting
    • Load Shedding with NS1
  • Active/Standby Clustering
  • AWS
    • Network Load Balancer
• Load Balancing
  • Caching
  • Compression
  • Circuit Breaking
  • Device Detection
    • 51Degrees
    • DeviceAtlas
    • WURFL InFuze
  • Geolocation
    • MaxMind
    • NetAcuity
  • Health Checking
    • Active Health Checks
    • Passive Health Checks
    • Agent Health Checks
    • LDAP Health Checks
    • MySQL Health Checks
    • PostgreSQL Health Checks
    • Redis Health Checks
    • SMTP Health Checks
  • Protocols
    • FastCGI
    • gRPC
    • HTTP/2
    • TCP
    • WebSocket
  • Response Body Injection
  • Session Persistence
• Traffic Routing
  • Blue-Green Deployments
  • Redirects
  • Rewrites
    • Rewrite Requests
    • Rewrite Responses
• Security
  • Authentication
    • Basic Authentication
    • Client Certificate Authentication
  • Bot Management
    • Verify Crawler
  • Response Policies
    • Deny
    • reCAPTCHA
    • Reject
    • Shadowban
    • Silent Drop
    • Tarpit
  • Single Sign-on
    • Active directory/LDAP
      • Implementing SSO
      • Configuring SSO
    • SAML
      • SAML Quick Start on Azure
      • SAML Reference
  • TLS
  • Additional Modules
• Observability
  • Logging
    • Overview
    • Log Custom Data
    • Log with Docker
    • Logging Reference
  • Metrics
    • Prometheus
    • Send Metrics
    • SNMP
  • Monitoring
    • Alerts
    • Monitor URI
  • Integrations
    • Grafana
    • Elastic Stack
    • InfluxDB
• API
  • Command Line Interface
  • Data Plane API
    • Installation
      • HAProxy Community
      • HAProxy Enterprise
    • CLI
    • Usage
    • Data Plane API Reference
  • Runtime API
    • Overview
    • abort ssl cert
    • add acl
    • add map
    • clear acl
    • clear counters all
    • clear counters
    • clear map
    • clear table
    • commit ssl cert
    • del acl
    • del map
    • disable agent
    • disable dynamic-cookie backend
    • disable frontend
    • disable health
    • disable server
    • enable agent
    • enable dynamic-cookie backend
    • enable frontend
    • enable health
    • enable server
    • get acl
    • get map
    • get weight
    • help
    • operator
    • prompt
    • quit
    • set dynamic-cookie-key backend
    • set map
    • set maxconn frontend
    • set maxconn global
    • set maxconn server
    • set rate-limit connections global
    • set rate-limit http-compression global
    • set rate-limit sessions global
    • set rate-limit ssl-sessions global
    • set server
    • set severity-output
    • set ssl cert
    • set ssl ocsp-response
    • set ssl tls-key
    • set table
    • set timeout cli
    • set weight
    • show acl
    • show backend
    • show cache
    • show cli level
    • show cli sockets
    • show env
    • show errors
    • show events
    • show info
    • show map
    • show peers
    • show pools
    • show resolvers
    • show schema json
    • show servers state
    • show sess
    • show ssl cert
    • show stat
    • show table
    • show threads
    • show tls-keys
    • show trace
    • shutdown frontend
    • shutdown session
    • shutdown sessions server
    • trace
    • user
  • Lua scripts
• Troubleshooting
  • Contact Us
• Licensing
  • End User License Agreement