Skip to main content
Use this page to decide what Sediment may capture, to keep its data and credentials private, and to verify a release before you install it.

​
Review what Sediment stores

Facts can contain model inputs and outputs, patch arguments, applied edit text, and observed file content. Mirrors contain pushed Git history. Git notes contain Session identifiers and timestamps. Before you enroll your team, agree which capture paths to enable. Privacy boundaries lists the fields that each path sends. Basic redaction replaces common credential shapes before Sediment stores a Fact. It isn’t complete secret detection. If a Fact contains a credential, quarantine it and rotate the credential. Facts and mirrors never expire. Backups hold the same content, so encrypt them and keep the decryption key off the server.

​
Separate the credentials

Never give an agent the operator token, server.env, or a database credential. A process under the same operating-system account as those files can read them.

​
Limit network exposure

GET /health and the API schema pages (/docs, /redoc, and /openapi.json) need no credential and return no captured content. To turn off the schema pages, set SEDIMENT_ENABLE_DOCS=false. Every other route needs a capture token, an operator token, a retrieval token, or a valid webhook signature. Keep PostgreSQL off the public network. Each entry in SEDIMENT_ALLOWED_CLONE_HOSTS is a host that Sediment trusts to fetch from. An explicit entry can permit a private address. Sediment sends no analytics, crash reports, or update checks. Your model endpoint, not Sediment, decides where inference content goes. To keep all content inside your network, run the gateway, model endpoint, and Git remotes there too. Run one API process. It serves two concurrent report or evidence reads with a 30-second deadline, and runs two mirror workers with a 120-second deadline and up to 16 queued jobs. A third concurrent read returns 503.

​
Verify a release

Each GitHub release publishes checksums, software bills of materials (SBOMs), vulnerability scan results, and a support end date. To check a release before you install it:
  1. Download the release assets into a private directory, and verify them against SHA256SUMS.
  2. Check that security-support.json names the expected Git revision and a support period that hasn’t ended.
  3. Match the wheel hashes in the client inventory to the packages that you install.
  4. Read each .gate.json result. A disposition applies only to the exact package, version, and architecture that it names.
  5. Record the installed version (sediment --version) and the support end date. Upgrade before that date.
Release scans cover Sediment’s packages and images. They don’t cover your operating system, PostgreSQL, reverse proxy, Traefik, or gateway. Keep those patched through their own channels. Maintainers follow Security verification and release policy.