Documentation
Self-Hosting Guide
Take full ownership of your data and infrastructure. Deploy Api Studio anywhere Docker or Node.js can run.
Minimum Requirements
| Components | Docker Full | Manual |
|---|---|---|
| Docker Compose | — | |
| Node.js 20+ | INCLUDED | |
| PostgreSQL 16 | INCLUDED | |
| Redis 7+ | INCLUDED |
Configuration
Define your core settings. Copy the example below into a.envfile in your project root.
.env
# DATABASE ACCESS
DATABASE_URL="postgresql://user:password@localhost:5432/apiclient"
POSTGRES_PASSWORD="secure-password-here"
# AUTHENTICATION
BETTER_AUTH_URL="http://localhost:3000"
NEXT_PUBLIC_WEB_PUBLIC_URL="http://localhost:3000"
# Generate with: openssl rand -base64 32
BETTER_AUTH_SECRET="your-32nd-char-secret"
# CACHING (REQUIRED)
REDIS_URL="redis://localhost:6379"
Deployment Methods
Battery-Included Bundle
Uses docker-compose.full.yml to handle DB & Redis automatically.
1
Run Deployment Service
docker-compose -f docker-compose.full.yml up -d
Troubleshooting
Env Parsing
Values with special characters must be wrapped in double quotes.
DB Read-Only
Ensure Postgres service is running and credentials match your .env.
Still need help?
Join our community on Discord or follow updates on GitHub.