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

portal documentation

Portal turns a Git repo of YAML into a running site. Almost everything here is about that YAML: what a content repo may say, and what the engine does with it.

Getting startedBringing your people in: from an empty Kanidm to everyone at their own desk, from what the content says.
ArchitectureWhat the engine is made of and where each piece lives in the source.
Content referenceEvery key a content repo may write, and what it does.
State machinesaggregates.yaml: stages, who moves a case, mail, deadlines, memberships.
AccessHow the Cedar policy is compiled from content, and who may ask it what.
MembershipsGroups kept by portal itself: a membership as a case, a person as a phone number first, and the provider only saying who.
OperationsReleasing, deploying, adding a site, environment variables.
Filesystem routesWhy the questions/ tree is the router.

Two repos in the same family carry their own docs:

  • uhhm/iris — the lint. Versioned as portal and released by portal’s publish job; it is the thing a content repo’s CI runs before anything reaches a site.
  • uhhm/gdo — the mailer. Delivers what content asked to be sent, and carries replies back.