Documentation

This section is the deeper explanation layer of the public site. Start with the conceptual pages if you want the system model, or jump straight to a backend family if you care about one domain.

Start here

Page	Why to read it
Architecture	The big-picture split between frontends, backends, and shared primitives
Frontends	How SSH, HTTP, DNS, SMTP, IMAP, and mDNS behave as transports
Primitives	The small shared building blocks reused across the system

Backend families

• Sites — Static and Markdown site hosting over HTTP

  • Getting started: Markdown site
  • Getting started: HTML site
  • Directory structure
  • Writing and customizing templates
  • Taxonomies and tag pages
  • Running multiple sites
  • Publishing over public HTTPS
  • Private sites and access grants
  • Local preview and build workflow
  • This site on Everlock

• Git — Git repositories, SSH interaction, and repository persistence

  • Managing repositories
  • Access control and grants

• Users, groups, and access control — The unified identity and permission model

  • Managing users
  • Groups

• Images — Image and media serving over HTTP

• Admin — Operator-facing admin flows over SSH and HTTP

  • Admin over SSH and CLI
  • Admin over HTTP

• AI — Embedded AI prompting through the admin SSH session, and image captioning shared with the image backend

• DNS — Authoritative DNS and derived records from Everlock services

  • Getting started: standalone DNS zone
  • Getting started: DNS zone with site and mail

• OCI — OCI registry backend over HTTP

  • Getting started: OCI registry

• Mail — SMTP receive and submission, IMAP read/write access, rules-based storage, and forwarding

  • Getting started: Inbound mail
  • Getting started: Outbound mail
  • Getting started: IMAP access

• Calendar — CalDAV calendars with Everlock auth and versioned storage

• Contacts — CardDAV contacts with Everlock auth and versioned storage

• OAuth — OAuth 2 / OIDC token issuance