Joinery Platform Documentation
Welcome to the Joinery platform documentation. Select a topic from the sidebar, or browse the categories below.
Getting Started
- Quick Start -- New? Start here. Rent a server, point your domain, and install Joinery in about 15 minutes — no prior experience required
- Installation -- Full reference: Docker or bare-metal, SSL, domain management, multi-site, cloning
Core Systems
- Routing -- How pages are created and served, URL patterns, and the theme override chain
- Logic Architecture -- Business logic layer, LogicResult pattern, and page flow
- Admin Pages -- Building admin interface pages with AdminPage, tables, and forms
- FormWriter -- Form generation, validation integration, and field types
- Validation -- Three-layer validation system (client, server, model)
- Settings -- System settings management and auto-creating settings
- Email System -- Composing and sending email with templates, service fallback, and batch operations
- Mailbox -- Self-hosted email: receiving, forwarding, local mailboxes, webmail reader, IMAP sync, DKIM/SRS
- Photo System -- Multi-photo management, uploads, and image sizing
- Cloud Storage -- S3-compatible cloud bucket for public uploaded files
- Deletion System -- Soft delete, permanent delete, cascading, and foreign key actions
- SEO Metadata -- SEO, Open Graph, and Twitter Card conventions for public views
Features
- Analytics -- Visitor events, conversion tracking, and attribution reporting
- A/B Testing -- Experiments, variant assignment, and conversion measurement
- Personal Calendar -- Subject-owned timeline, item-source registry, busy projection, and recurring native entries
- Recurring Events -- Virtual/materialized instance pattern for recurring events
- Subscription Tiers -- Subscription management and feature-based access control
- Product Purchase Hooks -- Plugin hooks triggered on product purchase
- Product Requirements -- Collecting data from buyers at checkout
- Questions & Surveys -- Built-in questionnaire system: question types, surveys, answer storage
- Social Features -- Like/favorite, block, report, and messaging systems
- Scheduled Tasks -- Cron-based task runner and task development
- REST API -- API authentication, endpoints, and usage
- Joinery AI Plugin -- LLM-driven recipes and the generic
query_model read surface - ScrollDaddy Plugin -- DNS filtering: unified block model, tier gating, editor UI, resolver flow
Security
- Account Security -- The doctrine: sign-in paths, the passkey role split, step-up, unlock windows, and what every sensitive action requires
- Passkeys -- Platform WebAuthn: sign-in, step-up confirmation, PRF secret derivation, and the consumer contract
- Sealed Vault -- Per-user encryption identity: key hierarchy, unlock window, consumer hooks, and key rotation
- SecretBox -- Authenticated encryption for server-held secrets at rest
- OAuth2 Core -- Platform OAuth2 client, provider catalog, consumers, and callback flow
- File Signed URLs -- Short-lived signed links for private files
Extensibility
Operations