Deployment Guide
Deploy your platformkit application with Docker Compose or directly on any Linux server.
Docker Compose (Recommended)
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
| Service | Port | Purpose |
|---|---|---|
| App | 8080 | Main application |
| PostgreSQL | 5433 | Primary database |
| Redis | 6379 | Cache + job queue |
| NATS | 4222 | Event 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)