Skip to content

Sovereign repositories

Sovereign uses a small set of first-party repositories. This page is the canonical map for what each repository owns, whether it is active or archived, and which docs should point to it.

Core repositories

RepositoryStatusPurpose
sovereignfs/sovereignActivePrimary platform repository: runtime, auth app, packages, built-in platform plugins, docs, RFCs, and roadmap.
sovereignfs/sovereign-legacyArchivedPrevious Sovereign codebase. Kept for historical reference and migration context only; new work happens in sovereignfs/sovereign.

Plugin repositories

RepositoryStatusPurpose
sovereignfs/sovereign-plugin-templateActive templateCanonical standalone plugin starter repository. Use this when creating a plugin outside the monorepo.
sovereignfs/sovereign-plugins-examplesActiveExample plugins demonstrating basic, API provider, minimal shell, monetized, and overlay app patterns. The platform bundles these at build/install time as hidden-by-default examples.
sovereignfs/sovereign-tasksActiveDefault bundled Tasks plugin. It is a real product plugin, visible from first boot, and versioned independently of the platform.
sovereignfs/sovereign-plainwriteActiveDefault bundled Plainwrite plugin — a git-backed content editor for static site generators. It is a real product plugin, visible from first boot, and versioned independently of the platform.

Documentation and deployment support

RepositoryStatusPurpose
sovereignfs/storybookActive deployment targetGitHub Pages repository for the built @sovereignfs/ui Storybook static site, served at sovereignfs.github.io/storybook. Source stories live in this primary repository under packages/ui.
sovereignfs/sovereign-infraActive templateOperator-owned self-hosting template for Ubuntu VPS deployments: Caddy, Docker Compose, age-encrypted .env files, matching-tag deploys of official Sovereign images, and GitHub Actions CI/CD. No Terraform or managed-cloud dependency.
sovereignfs/sovereignfs.github.ioActive deployment targetGitHub Pages repository for the public VitePress docs site at sovereignfs.github.io. Source docs live in this primary repository under docs/.

Naming notes

  • Use sovereignfs/sovereign-plugins-examples, not sovereign-examples.
  • Use sovereignfs/sovereign-tasks, not sovereign-plugin-tasks.
  • Use sovereignfs/sovereign-plainwrite, not sovereign-plugin-plainwrite.
  • sovereignfs/storybook and sovereignfs/sovereignfs.github.io are deployment targets. Edit source stories and docs in sovereignfs/sovereign.
  • sovereignfs/sovereign-infra is a template that operators fork or use as a GitHub template. The platform repository publishes release images; the operator's infra repository controls when those images are deployed to the operator's VPS.
  • Historical planning docs may mention older candidate repositories such as Splitify, API Composer, or PaperTrail. They are not part of the current support-repository set unless this page is updated.

Open source under AGPL-3.0. Each Sovereign instance is independently operated.