Deployment Guide

Deploy with Docker Compose, run migrations, and prepare for production.

Deployment Guide

Deploy your platformkit application with Docker Compose or directly on any Linux server.

The fastest path to production:

# Clone and configure
git clone https://github.com/septagon-dev/platformkit-apps.git
cd platformkit-apps/complete-saas-monolith
cp config.yaml config.prod.yaml
# Edit config.prod.yaml with production values

# Build and start
docker compose up -d --build

Services Included

ServicePortPurpose
App8080Main application
PostgreSQL5433Primary database
Redis6379Cache + job queue
NATS4222Event bus

Database Migrations

Migrations run automatically during startup:

make up   # boot the stack and apply migrations automatically
make logs # inspect app startup and migration output

Health Checks

The application exposes standard health endpoints:

  • GET /live — liveness probe (always 200 if process is running)
  • GET /ready — readiness probe (checks DB, Redis, NATS)

Production Checklist

  • [ ] Set strong JWT_SECRET (minimum 32 characters)
  • [ ] Enable HTTPS (reverse proxy with nginx/Caddy)
  • [ ] Configure CORS allowed origins
  • [ ] Set up database backups
  • [ ] Enable structured logging (LOG_FORMAT=json)
  • [ ] Configure rate limiting
  • [ ] Set up monitoring (Prometheus metrics at /metrics)

Welcome back

Sign in securely without losing your place.

Preparing secure sign-in…

Having trouble? Open the full sign-in page