Deployment Overview

Complete deployment guides for Synap Backend

Deployment Options

Self-Hosted Data Pod

• Full control over your data
• Open source
• Requires infrastructure management

See Self-Hosted Deployment

Docker Compose

• One-command deployment
• Includes PostgreSQL and MinIO
• Perfect for development

See Docker Deployment

Production Cloud

• Managed infrastructure
• Scalable
• High availability

See Production Deployment

Prerequisites

• ✅ PostgreSQL 15+ with pgvector extension
• ✅ Typesense for full-text search
• ✅ Cloudflare R2 or MinIO for file storage
• ✅ API keys for AI providers (via OpenRouter)
• ✅ Node.js 20+

Quick Start

Docker Compose (Development)

# 1. Create .env
cp env.local.example .env
# Add your API keys
 
# 2. Start services
docker compose up -d
 
# 3. Initialize database
pnpm --filter database db:init
 
# 4. Start backend
pnpm dev

Checklist

Configuration

• Environment variables configured
• Database initialized
• Migrations applied
• Storage configured

Security

• Secrets secured (not in code)
• CORS configured
• Rate limiting enabled
• Auth configured

Monitoring

• Health checks configured
• Logs centralized
• Alerts configured

Next: See specific deployment guides for detailed instructions.

:::info Learn more on the website

• Self-Hosting guide — practical overview of deploying and running Synap on your own infrastructure
• Data Pods — learn about Synap's sovereign data architecture :::