Customize Your Installation

Configure Zentinel with the agents you need. Generate installation commands and starter configuration for your use case.

Zentinel 26.04_1

1 Installation Method

2 Official Agents

Select the agents you want to include. All agents are optional and can be added later.

Looking for more? We have 25+ agents for security, observability, and traffic management.

Browse All Agents

3 Installation

Shell
# Install Zentinel proxy
curl -fsSL https://get.zentinelproxy.io | sh

# Select agents above to include them in the installation

4 Example Configuration

A starter configuration with your selected agents. Save as zentinel.kdl

zentinel.kdl
// Zentinel Configuration
// https://zentinelproxy.io

system {
    worker-threads 0  // 0 = number of CPU cores
    graceful-shutdown-timeout-secs 30
}

listeners {
    listener "http" {
        address "0.0.0.0:8080"
        protocol "http"
    }
}

routes {
    route "default" {
        matches {
            path-prefix "/"
        }
        upstream "backend"
    }
}

upstreams {
    upstream "backend" {
        targets {
            target {
                address "127.0.0.1:3000"
            }
        }
        load-balancing "round_robin"
    }
}

// No agents configured

5 Run Zentinel

Start Zentinel with your configuration file.

Shell
# Start Zentinel
zentinel --config zentinel.kdl

6 Verify It Works

Send a request to confirm the proxy is running and forwarding traffic.

Shell
# Test the proxy is forwarding requests
curl -i http://localhost:8080/
HTTP/1.1200 OKx-zentinel-request-id: a1b2c3d4-e5f6-7890 x-zentinel-upstream: 127.0.0.1:3000

Make sure your backend (127.0.0.1:3000) is running before testing. If you see a 502, the proxy is working but can't reach the upstream.

7 What's Next

  • Add TLS — Configure HTTPS listeners with your certificates. Listener docs
  • Add more routes — Match by path, host, headers, or methods. Routing docs
  • Install agents — Add WAF, rate limiting, or auth with zentinel bundle install. Agent registry
  • Enable health checks — Monitor upstream availability automatically. Upstream docs
  • Deploy to production — systemd, Docker, or Kubernetes. Deployment guide