mkdir -p /opt/synapsis && cd /opt/synapsis
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker-compose.yml
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker/Caddyfile
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker/.env.example
cp .env.example .env
nano .env  # Add your domain and secrets
docker compose up -d

Your node is live at https://your-domain.com with automatic SSL.

📋 What You Need

Requirement	Details
Server	2GB RAM, 2 CPU cores, 20GB SSD (minimum)
Domain	A domain or subdomain pointing to your server
Docker	Version 24.0+ with Docker Compose 2.20+
Storage	S3-compatible service (AWS S3, MinIO, Wasabi, Backblaze B2, etc.)

Install Docker (Ubuntu/Debian):

curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
newgrp docker

⚙️ Configuration

Edit .env and set these required values:

Variable	What to put
`DOMAIN`	Your domain (e.g., `synapsis.example.com`)
`DB_PASSWORD`	Strong password for PostgreSQL
`AUTH_SECRET`	Run: `openssl rand -hex 32`
`ADMIN_EMAILS`	Your email address
`STORAGE_*`	Your S3-compatible storage credentials

Port Configuration:

PORT=auto (default) — Automatically finds an available port between 3000-3020
PORT=3000 — Use a specific port instead

🔄 Updates

cd /opt/synapsis
docker compose pull && docker compose up -d

🛠️ Common Commands

# View logs
docker compose logs -f app

# Restart services
docker compose restart app

# Stop everything
docker compose down

# Database backup
docker compose exec postgres pg_dump -U synapsis synapsis > backup.sql

# Access database
docker compose exec postgres psql -U synapsis -d synapsis

🔍 Troubleshooting

Container won't start

docker compose config  # Validate config
docker compose logs app --tail=50  # Check errors

Port already in use

PORT=auto (default) automatically finds an available port. If you set a specific port that's taken:

# Check what's using the port
sudo netstat -tlnp | grep :3000

# Switch back to auto or choose a different port
# Edit .env: PORT=auto

Database connection failed

# Check database health
docker compose ps

# Verify environment variables loaded
docker compose exec app env | grep DATABASE

SSL certificate issues

# Check Caddy logs
docker compose logs caddy

# Test Caddy config
docker compose exec caddy caddy validate --config /etc/caddy/Caddyfile

Image pull fails

# Verify image exists
docker pull ghcr.io/cyph3rasi/synapsis:latest

# Check available tags at:
# https://github.com/cyph3rasi/synapsis/pkgs/container/synapsis

💾 Backup Strategy

Create /opt/synapsis/backup.sh:

#!/bin/bash
BACKUP_DIR="/var/backups/synapsis"
DATE=$(date +%Y%m%d_%H%M%S)
mkdir -p $BACKUP_DIR

# Database backup
docker compose exec -T postgres pg_dump -U synapsis synapsis > "$BACKUP_DIR/db_$DATE.sql"

echo "✅ Backup complete: $DATE"

Schedule daily backups:

chmod +x /opt/synapsis/backup.sh
echo "0 2 * * * /opt/synapsis/backup.sh" | sudo crontab -

🏗️ Building from Source

To build locally instead of using pre-built images:

git clone https://github.com/cyph3rasi/synapsis.git
cd synapsis/docker
docker compose -f docker-compose.build.yml up -d --build

For full documentation, visit docs.synapsis.social