Creator and developer docs

PostSnail Documentation

Everything needed to write a microblog, publish it as static files, register it in Forest, and understand the proof architecture.

Alpha 2 ReleaseWhat changed, what stayed stable, and which prototype paths were removed for the lean release. How To Use PostSnailCreate identity, write posts, attach images, export encrypted workspaces, and download a public Website ZIP. PostSnail CLIOpen encrypted Shells, import Markdown drafts, build public files, verify output, and create ZIPs from a terminal. Headless PublishingUse trusted local automation without turning the browser admin into a backend dependency. Encrypted Workspace VaultUse private .postsnail files as the editable source for your microblog. PublishingChoose Download ZIP or Surge while keeping the private Shell out of public hosting. Publish On SurgeUse the Surge bridge or public ZIP fallback to deploy and verify public proof files. SnailLiftDeploy public generated files through Surge, verify live proof files, and notify Forest after verification. SnailLift SurgeUse the local bridge and Surge credentials stored in the encrypted Shell. SnailLift SecurityToken, Shell privacy, safety scan, and live verification boundaries. PostSnail PagesEnable the official CMS plugin for static pages, docs, navigation, and homepage override. PostSnail CommentsEnable the official comments plugin for approved static replies and private moderation in the Shell. Signature BadgesCollect deterministic two-color proof seals and publish a badge bookmark page. ShellNamesClaim readable Forest aliases like @creator@forest.postsnail.org without creating an account. ShellNames ProtocolSigned alias record shape, Forest endpoints, search behavior, and compatibility rules. ShellNames SecurityWhat aliases prove, what they do not prove, and how Forest limits abuse. Site MovesChange domains safely with a signed move or mirror record that Forest can verify. PostSnail ConceptThe local-first publishing model, Forest tracker role, and trust boundaries. PostSnail ArchitectureAdmin modules, static bundle shape, proof files, registry Worker, and extension points. Core FoundationWhat PostSnail Core owns, what stays out of Core, and the first extension boundaries. Plugin SystemOfficial bundled plugins, validated manifests, registry state, hook plans, permissions, and route-scoped runtime declarations. Plugin MigrationsPreserve missing plugin state, unknown fields, and private extension data inside the encrypted Shell. Theme SystemFrontend theme registries, admin theme tokens, Quiet Feed defaults, and compatibility rules. Theme ManifestsFrontend and admin manifest shapes for themes that style without becoming plugins. Route AssetsDeclare public CSS and JS per route so plugins and themes do not load globally by default. Permission ModelPlugin permissions, sensitive permissions, and boundaries for future PSEPs. Extension SecurityInstall does not mean load; route scoping and export safety keep extensions contained. Security NotesWhat workspace encryption protects, what proof files prove, and what passphrase loss means. Compatibility ContractStable core, optional extensions, required features, legacy warnings, and migration promises. Protocol ReferenceManifest, well-known identity, commit proofs, Shell vaults, and tracker announce records. Workspace MigrationsHow versioned workspace migrations keep old editable projects importable. PSEP ProcessHow PostSnail Enhancement Proposals govern protocol-risk changes. PostSnail LegalApache-2.0 license, NOTICE attribution, third-party notices, logo provenance, and Forest cost notes.