Reference
Glossary
The terms used in self-hosting, with what each means in Sovrain.
Terms in alphabetical order. Labels from the screens are in bold.
- ACME, DNS challenge
- How a node gets its TLS certificates from Let’s Encrypt: it proves control of the domain with a DNS record, through ClouDNS or OVH. See Set up TLS with DNS.
- Custom domain
- An organization’s own domain, such as
login.acme.example, in place ofacme.sovrain.net. When it is Active (the primary domain), it is the issuer and the base of every address. - Data directory, data volume
- Everything a node stores: one SQLite database per organization with its password manager attachments,
node.sqliteandmek-fingerprint./datainqaandprod. See Data directory. - Landing host
- The address without an organization, such as
sovrain.netor a self-hostedsso.example.com, where organizations are registered. - Landing node
- The node that serves the landing host, such as
sso.example.com, and registers new organizations. At most one node is the landing node. - Local profile
localinSPRING_PROFILES_ACTIVE: plain HTTP athttp://idp.localhost:8080, a development master key, emails written to the log with their body. Only for trying Sovrain out. See Try Sovrain on your computer.- Master encryption key (MEK)
IDP_MEK, Base64 of 32 bytes. The keys inside the databases are wrapped under it: a node refuses to start with a different key, and a backup is useless without it.- Node
- One running Sovrain server. A node serves its region alone; there is no failover between nodes.
- Organization address
- The
acmeinhttps://acme.sovrain.net. Chosen at registration; it cannot be changed. - Peers file
- The file that lists every node with its region and whether it is the landing node. Set with
IDP_NODE_PEERS_FILE, by default/etc/paas/peers. - Profile
local,qaorprodinSPRING_PROFILES_ACTIVE. It decides HTTPS, required secrets and how mail is sent. See Profiles.- Proof of work
- A task the browser solves before an organization is registered, in place of a CAPTCHA. Set with the
IDP_REGISTRATION_POW_*variables. - Ready check
/readyon the node. It answers whether the node is ready and whether its certificate is in place.- Region (self-hosting)
- A part of a Sovrain installation served by one node at
<region>.<base>. Each organization lives in one region, chosen at registration. See Peers file. - Region host
<region>.<landing host>: the address of the node that serves a region and theCNAMEtarget of its organizations’ addresses; never an organization’s own address.- SMTP relay
- The mail server through which a node sends every email. Required in
qaandprod. See Configure outgoing mail. - Wildcard certificate
- The certificate for
*.<landing host>on every node, which covers every organization’s address. The landing node also has one for the bare landing host.