The Fediversity data model's own options, declared in core/lib/data-model.nix.

Collection of Fediversity components

The file in this repository that gives the scalable artwork the component is shown by: a function { pkgs, sources }: { icon; iconDark ? null; }, where iconDark is the variant for a dark background. A surface in dark mode shows iconDark in place of icon, or icon if it is null. core/lib/artwork.nix calls the file.

A path and not the artwork, so that the plan of a node holds no store path. The file takes the artwork out of the upstream source (pkgs.<name>.src) instead of keeping it in this repository, so that the artwork an operator sees is the artwork the project ships. For a project whose source has no logo, it takes it from another repository of the project, pinned in npins. null for a component that no surface shows artwork for.

Whether the operator form shows this component and the options of its module. An optional component is always configurable, because the operator must be able to turn it on. Other components can declare their module options for the deployment only, so they are configurable only when they say so.

What the component is, for an operator choosing it.

A component states its own only where its part in a deployment is not what the project describes: valkey is a cache node with one instance per application, which pkgs.valkey has no way to say.

Home page of the project behind the component.

Operator-facing configuration options for the component

The name the component is called by, capitalized the way the project capitalizes itself (PeerTube, OpenBao).

Stated here because nixpkgs carries no display name: pname is an attribute name, lowercase by convention, while every surface an operator reads shows the project its own way.

Whether the operator turns this component on and off: it is an application in the glossary sense, software the operator picks. Components left at false are infrastructure that the applications need, and a deployment runs them without a choice from the operator.

Configuration type declaring options to be set by operators. Carries every declared component, so the deploy path (default-configuration, which enables every roster node including the infrastructure nodes) type-checks against it.

Run-time environments for Fediversity components to be deployed to

The mapping from an operator configuration to a deployment: it resolves each enabled component's required resources and then applies this environment's resource-mapping. Declared as a type-checked function whose output is a deployment (env-output).

Generates a deployment from a configuration by applying this environment's resource policies to the components' resource mappings. By default this is just config-mapping applied, i.e. the end-to-end "configuration in, deployment out" entry point for the environment.

Maps the resources required by the deployed components to the resources this environment actually offers, producing something that can be deployed. This is the environment-specific glue a hosting provider writes; its exact function type (resource-mapping.function-type) is fixed per deployment.

The function type for implementation: it takes the components' required resources (plus a deployment name) and returns a deployment (env-output). Declared as a type-checked function so inputs and outputs are validated.

Resources the hosting provider makes available in this environment, keyed by resource name, each holding that resource's policy (how the provider supplies it). Setting this is optional; it is a place to declare provider-side resource information for use in the resource mapping. The concrete shape of each entry is fixed by the matching resource's policy module under core/resources, so it depends on which resources the environment wires in.

Collection of deployment resources that can be required by components and policed by hosting providers

Description of the resource to help component module authors and hosting providers to work with it

Options for configuring the resource policy for the hosting provider, a description of how the resource is made available

Apply the policy to the requests

The type of the argument of apply. A policy whose own process keys the requests sets it. Each call of apply checks only the outer shape of its argument against this type.

Select the requests for this resource from the given components, then apply the policy to them

The type of resource this policy configures

A module that the resource merges into the eval of the contract provider. The module selects the provider and gives the provider its context, for example an address and a port. A resource that wraps no contract does not read this option.

Options for declaring resource requirements by a component, a description of how the resource is consumed or accessed

Supporting resource requests not tied to a single component, made available to every environment.

Operator-facing configuration for a Fediversity deployment, as set through the hosting provider's front end. This is the schema that drives the deployment form of the front end.

Whether to enable your Fediversity configuration.

What to run: a deployment method (ssh-hosts / tf-hosts / tf-incus-hosts / k8s-hosts) or a non-deploy operator effect (tf-incus-image / octodns-zone). Pick one, then fill in its settings. The tag key is the method/effect; its value is that entry's settings. A method deploys the enabled applications; an effect runs a standalone action. Always set -- there is no "no selection" state (issue #723).

Deploy to a kubernetes cluster via OpenTofu, with each node as a pod, and an HTTP state backend.

Per-application configuration the operator sets to enable and configure each Fediversity application.

Shared SSO node (Authelia). Its daemon config, the aggregated OIDC clients, the lldap first-factor backend, the OpenBao secret delivery, and the SMTP notifier account are wired by the setup (hosts-common.nix) from the oidc resource on the node that runs this component; this app model carries the node's SPIFFE identity and the operator's portal settings. Shared by the hosting-provider and operator groups (each group runs its own SSO portal).

Portal settings, from authelia's configuration file.

Shared LDAP directory node (lldap). Its daemon config, the per-consumer directory provisioning, and the OpenBao bind-password generation are wired by the setup (hosts-common.nix) from the directory.ldap resource on the node that runs this component; this app model carries the node's SPIFFE identity and the operator's mail settings. Shared by the hosting-provider and operator groups (each group runs its own directory).

Name of the sender of the directory's mail, such as a password reset.

Directory settings, from lldap's configuration file.

Self-hosted, globally interconnected microblogging software based on ActivityPub

Whether to enable Enable a Mastodon server on the machine.

Automatically remove remote media attachments and preview cards older than the configured amount of days.

Recommended in <https://docs.joinmastodon.org/admin/setup/>.

How old remote media needs to be in order to be removed.

Instance settings, from the environment Mastodon reads its configuration from.

Label the Mastodon instance is served under, below the domain of the deployment (e.g. mastodon for mastodon.example.org).

Free software to take back control of your videos

Whether to enable Enable a PeerTube server on the machine.

Instance settings, from PeerTube's own configuration file.

Label the PeerTube instance is served under, below the domain of the deployment (e.g. mastodon for mastodon.example.org).

Federated image sharing platform

Whether to enable Enable a Pixelfed server on the machine.

Max upload size with units.

Instance settings, from the environment Pixelfed reads its configuration from.

Label the Pixelfed instance is served under, below the domain of the deployment (e.g. mastodon for mastodon.example.org).

Apex domain under which the services will be deployed.

Password reset email for the SSO's admin user.

Address of the OpenTofu HTTP state backend REST endpoint (TF_HTTP_ADDRESS).

Address of the image registry, as host[:port][/path] (K8S_REGISTRY).

Manage DNS records for a zone via OctoDNS.

Path, on the deployer, to the file holding the service's API token. A PATH and never a value, so no credential reaches the Nix store: the effect reads it at run time. Empty means the provider needs no token (the self-hosted bind path authenticates with a TSIG key instead).

The DNS domain (zone) to manage.

The OctoDNS provider to use, see <https://octodns.readthedocs.io/en/latest/#providers>.

The files from which to read the secrets to use with the provider.

URL of the authoritative-DNS service's API, scheme and port included. Empty means the domain is served by the deployment's own bind node.

Deploy over SSH to existing hosts: a shared SSH identity plus, per node, where to reach it and any identity override.

Per-application configuration the operator sets to enable and configure each Fediversity application.

Shared SSO node (Authelia). Its daemon config, the aggregated OIDC clients, the lldap first-factor backend, the OpenBao secret delivery, and the SMTP notifier account are wired by the setup (hosts-common.nix) from the oidc resource on the node that runs this component; this app model carries the node's SPIFFE identity and the operator's portal settings. Shared by the hosting-provider and operator groups (each group runs its own SSO portal).

Portal settings, from authelia's configuration file.

Shared LDAP directory node (lldap). Its daemon config, the per-consumer directory provisioning, and the OpenBao bind-password generation are wired by the setup (hosts-common.nix) from the directory.ldap resource on the node that runs this component; this app model carries the node's SPIFFE identity and the operator's mail settings. Shared by the hosting-provider and operator groups (each group runs its own directory).

Name of the sender of the directory's mail, such as a password reset.

Directory settings, from lldap's configuration file.

Self-hosted, globally interconnected microblogging software based on ActivityPub

Whether to enable Enable a Mastodon server on the machine.

Automatically remove remote media attachments and preview cards older than the configured amount of days.

Recommended in <https://docs.joinmastodon.org/admin/setup/>.

How old remote media needs to be in order to be removed.

Instance settings, from the environment Mastodon reads its configuration from.

Label the Mastodon instance is served under, below the domain of the deployment (e.g. mastodon for mastodon.example.org).

Free software to take back control of your videos

Whether to enable Enable a PeerTube server on the machine.

Instance settings, from PeerTube's own configuration file.

Label the PeerTube instance is served under, below the domain of the deployment (e.g. mastodon for mastodon.example.org).

Federated image sharing platform

Whether to enable Enable a Pixelfed server on the machine.

Max upload size with units.

Instance settings, from the environment Pixelfed reads its configuration from.

Label the Pixelfed instance is served under, below the domain of the deployment (e.g. mastodon for mastodon.example.org).

Shared SSH identity applied to every node, unless a node overrides it.

Path to the SSH private key the deployer reads (a reference, not key material). Null uses an agent / the deployer default.

Extra SSH options applied to every node, each one a bare Key=Value such as Port=2222. The deploy puts -o in front of each item.

SSH user to connect as. Null uses the deployer default.

Apex domain under which the services will be deployed.

Password reset email for the SSO's admin user.

Per-node SSH connection info, one optional entry per node in the roster of each group that runs an application. A null field of a set node falls back: host to the roster FQDN, identity fields to defaults.

SSH connection info for this node. Omit to inherit defaults and the roster FQDN.

Host (address) to reach this node over SSH. Null uses the node's roster FQDN.

Public SSH host key of this node, one line of its ssh_host_*_key.pub. The deploy accepts only this key. Null accepts the key of the first connection.

Path to the SSH private key for this node. Null inherits defaults.keyFile.

SSH options for this node, each one a bare Key=Value such as Port=2222. The deploy puts -o in front of each item. A list replaces defaults.sshOpts; null inherits it.

SSH user to connect as for this node. Null inherits defaults.username.

SSH connection info for this node. Omit to inherit defaults and the roster FQDN.

Host (address) to reach this node over SSH. Null uses the node's roster FQDN.

Public SSH host key of this node, one line of its ssh_host_*_key.pub. The deploy accepts only this key. Null accepts the key of the first connection.

Path to the SSH private key for this node. Null inherits defaults.keyFile.