Documentation

This section is the operator manual. It reads in the order below, and each page also stands alone.

New to Écluse? What Écluse is covers the model on one page: the quarantine, the four registry roles, and the deny-by-default policy.

Trying it out? The Quick start puts a serve-only gate in front of real installs, with no mirror and no cloud account.

Taking it to production? Read Deploying Écluse for the topology and the network fences, Configuring Écluse for the layers, secrets, and rule policy, and Operating Écluse for the probes, logs, and sizing. Running the Dredger covers the one role that deletes.

Looking something up? Protocol support says exactly what the server speaks, and the Threat model records what Écluse defends against and what it assumes of your deployment.

If you are reading or extending the code instead, the API reference holds the Haddock for each library.

Design documents on GitHub#

The pages above say how to run Écluse. The design documents in the repository carry the why, and each link below leaves the site for GitHub:

• Architecture overview
• Configuration and authentication
• Security posture
• Rules engine
• Multi-ecosystem hosting and URL rewriting
• Release and supply-chain operations