Fediversity

This site documents the Nix parts of Fediversity. Each group below has an overview page that lists its pages.

• Concepts -- the actors, and the terms that the other pages use.
• Guides -- how a hosting provider and a maintainer do their tasks.
• Reference -- the options, the contract types, the flake attributes and the utility functions, generated from the code.
• Technical design -- the view of the full system: the actors and external systems, the components, and which component installs, configures and updates applications, manages users and moves a deployment between hosting providers.
• Specifications -- what core must do, and the principles that apply to all changes in core/.
• Compliance -- the threat model, the SBOM, the license decisions, data protection, the legal roles and the technical documentation of the Cyber Resilience Act.

Other sites

The operator-facing web frontend and the deployment backend have their own documentation sites, built from their respective components:

• Panel -- the Django web frontend operators use to configure and trigger deployments, and its services.panel NixOS options. Its guides tell operators how to deploy and manage their applications.
• API -- the HTTP and Centrifugo pub/sub backend that runs deployments and reports progress, and its services.fediversity-api NixOS options. Its wire surface is also browsable as Swagger UI (HTTP) and AsyncAPI (Centrifugo pub/sub).