Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Running an instance

Sigillr is written in Rust. This page covers what works today and what later releases add.

Install

Build from source with a recent stable Rust toolchain. Clone https://github.com/startr-trade/sigillr, then from the checkout:

cargo build --release --locked
./target/release/sigillr --help

What later releases add

The current build is the workspace skeleton: it has the command-line entry point and nothing that serves requests yet. Later releases add, in order, the registry repository and index, mutual-TLS login and key registration, public verification, revocation checks (CRL and OCSP), and the OpenID Connect provider. Each release’s notes are under Release notes.

The settings an instance will take are listed in Configuration.

Publishing this guide

The guide is built with mdBook (make docs, or mdbook build docs/guide) and published to GitHub Pages by .github/workflows/docs.yml. GitHub Pages must be enabled once for the repository: Settings, Pages, Source “GitHub Actions”. That switch belongs to the repository owner.