Self-Hosting Guide

Your Data. Your Rules.

Take full ownership of your API testing environment. Deploy Api Studio on your own infrastructure with zero hidden telemetry and zero vendor lock-in.

Minimum Requirements

Components	Docker Full	Manual
Docker Compose		—
Node.js 20+	INCLUDED
PostgreSQL 16	INCLUDED
Redis 7+	INCLUDED

Configuration

Define your core environment variables. Copy the example below into a .env file 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 our docker-compose registry to instantly spin up Postgres, Redis, and the Application — all in a single command.

Run the Deployment Stack

docker-compose -f docker-compose.full.yml up -d

Troubleshooting

Env Parsing Issues

Values with special characters must be wrapped in double quotes in your .env file.

DB Connection Denied

Ensure the PostgreSQL service is running and credentials match your configured DATABASE_URL exactly.

Still need help?

Join our developer community on Discord or follow the project updates on GitHub.

Join our Discord Star on GitHub