InboxorcistInboxorcist

Deployment Overview

Choose the best deployment method for your needs.

Inboxorcist can be deployed in multiple ways depending on your needs. All methods support the full feature set.

Comparison

MethodDifficultyDatabaseBest For
Single BinaryEasiestSQLite or PostgreSQLPersonal use, VPS, cloud servers (Recommended)
DockerEasyPostgreSQLUsers who prefer containers
RailwayVery EasyPostgreSQLQuick cloud deployment
RenderVery EasyPostgreSQLAutomatic deploys from Git
Fly.ioEasyPostgreSQLGlobal edge distribution
DigitalOceanEasyPostgreSQLManaged PaaS
Custom VPSEasySQLite or PostgreSQLMaximum control

Recommended: The single binary is the simplest way to deploy Inboxorcist. It supports both SQLite and PostgreSQL, requires zero dependencies, and works on any VPS or cloud server.

Prerequisites for All Methods

Before deploying, you'll need:

  1. Google OAuth Credentials - Setup guide
  2. Security Secrets - Generated by the setup script or manually:
# Generate JWT_SECRET (32+ characters)
openssl rand -base64 32

# Generate ENCRYPTION_KEY (64 hex characters)
openssl rand -hex 32

Architecture Options

The binary runs as a single process with your choice of database:

┌─────────────────────────────┐
│   Inboxorcist Binary        │
│   (API + SPA on :6616)      │
└─────────────┬───────────────┘
              │
              ▼
    ┌─────────────────┐
    │ SQLite (local)  │  ← Default: zero setup
    │       OR        │
    │ PostgreSQL      │  ← Cloud deployments
    └─────────────────┘

Docker

Docker deployment with bundled PostgreSQL:

┌─────────────────────────────────┐
│         Docker Container        │
│  ┌─────────────────────────┐    │
│  │   Inboxorcist Server    │    │
│  │   (API + SPA on :6616)  │    │
│  └────────────┬────────────┘    │
└───────────────┼─────────────────┘
                │
                ▼
       ┌─────────────────┐
       │    PostgreSQL   │
       └─────────────────┘

Quick Start Commands

Binary (Recommended):

curl -fsSL https://inboxorcist.com/install.sh | bash

Docker:

docker compose up -d

Choose Your Deployment

On this page