Documentation

PostOrbit Docs

Everything you need to deploy, configure, and master PostOrbit for your email marketing needs.

Quick Start

Get PostOrbit running in under 5 minutes with these commands:

# Clone the repository

git clone https://github.com/etherlabz/postorbit.git

# Install dependencies

cd postorbit && npm install

# Set up environment

cp .env.example .env

# Run database migrations

npx prisma migrate deploy

# Start the development server

npm run dev

Quick start guide to deploy PostOrbit in minutes

Configure PostgreSQL and run migrations

Environment variables and settings

Learn about PostOrbit's powerful features

View source code, report issues, and contribute

Get help from the community and team

Complete API documentation (coming soon)

Configure these environment variables in your .env file:

Variable	Description
DATABASE_URL	PostgreSQL connection string
NEXTAUTH_SECRET	Secret for NextAuth.js session encryption
NEXTAUTH_URL	Your application URL (e.g., http://localhost:3000)
RESEND_API_KEY	Your Resend API key for sending emails

Join our Discord community for support, or open an issue on GitHub.