Clearplane documentation

Deploy, configure, protect, and operate Clearplane.

Clearplane is a self-hosted web security gateway for routing and protecting traffic in infrastructure you control. It is source available and free to self-host, including for internal business use, under the Sustainable Use License.

Start here

Installation covers Docker Compose installation, first setup, updates, and the container lifecycle.

Understand the model

Concepts explains routes, clusters, destinations, policies, configuration ownership, and the revision lifecycle.

Understand the trust boundaries

Security & Trust explains public exposure, network isolation, internal service identity, container-runtime access, and layered hardening.

Complete a task

Guides cover publishing, HTTPS, protection, access, traffic, and delivery through the UI or Docker labels.

Operate and troubleshoot

Operations covers status, traffic, security events, configuration changes, and service troubleshooting.

Use the CLI

CLI lists every embedded Core command for status, setup, administrator recovery, bans, database maintenance, and secret rotation.

Look up a setting

Reference contains every supported Docker label and environment variable, including accepted values, defaults, and apply behavior.

Write or review WAF rules

WAF rule language covers ruleset JSON, conditions, token detectors, scoring and tested examples.