Self-Hosting
Sitepins is free, open source, and built to be self-hosted. When you run Sitepins yourself, you get the entire product with every feature unlocked — no subscription tiers, no usage caps, and no paywalls.
This section provides complete documentation for operating and developing with Sitepins:
- Architecture & Stack: Runtime topology, process architecture, data flows, and security boundaries.
- Installation: Docker Compose and manual pnpm installation procedures.
- Environment Variables: Exhaustive reference for every backend and frontend configuration variable.
- Git Provider Setup: Step-by-step setup for GitHub Apps, GitHub OAuth, and GitLab OAuth.
- Media Storage: Configuring S3-compatible storage across AWS, Cloudflare R2, MinIO, and DigitalOcean.
- Reverse Proxy & SSL: Production Nginx and Caddy setups with mandatory WebSocket upgrade routing.
- Real-Time Collaboration & Live Preview: Deep dives into Hocuspocus (Yjs CRDT), Socket.IO gateways, and Vercel Sandboxes.
- Project Configuration: Complete specification of
.sitepins/config.json, sidebar arrangement rules, and schema migrations. - API Reference: Comprehensive REST endpoints and Next.js route handlers.
- Extension Points: Adding request guards, transactional mailers, auth issuers, and lifecycle hooks without forking.
- Troubleshooting & Runbook: Diagnostic matrices and database backup/recovery guides.
- Contributing to Core: Local development workflows, Vitest testing, and quality verification gates.
Last updated on