Quick Start
Get Inboxorcist running in under 2 minutes. No Docker required.
Prerequisites
- A Google account with Gmail
- Google OAuth credentials (setup guide)
Option 1: One-Line Install (Recommended)
The fastest way to get started.
curl -fsSL https://inboxorcist.com/install.sh | bashThis installs to ~/.inboxorcist. The installer will ask if you want to use SQLite (default) or PostgreSQL.
Then start:
~/.inboxorcist/inboxorcistOr add to your PATH:
echo 'export PATH="$HOME/.inboxorcist:$PATH"' >> ~/.zshrc
source ~/.zshrc
inboxorcistcurl -fsSL https://inboxorcist.com/install.sh | bashThis installs to ~/.local/share/inboxorcist. The installer will ask if you want to use SQLite (default) or PostgreSQL.
Then start:
~/.local/share/inboxorcist/inboxorcistOr add to your PATH:
echo 'export PATH="$HOME/.local/share/inboxorcist:$PATH"' >> ~/.bashrc
source ~/.bashrc
inboxorcistOpen PowerShell and run:
irm inboxorcist.com/install.ps1 | iexThis installs to %LOCALAPPDATA%\Inboxorcist. The installer will ask if you want to use SQLite (default) or PostgreSQL.
Then start:
& "$env:LOCALAPPDATA\Inboxorcist\inboxorcist.exe"Or add to your PATH:
[Environment]::SetEnvironmentVariable("PATH", $env:PATH + ";$env:LOCALAPPDATA\Inboxorcist", "User")
# Restart PowerShell, then:
inboxorcistOn first run, the browser opens automatically to the setup page. Secure secrets are generated automatically.
Option 2: Manual Download
Download the latest release for your platform from GitHub Releases.
Apple Silicon (M1/M2/M3):
curl -LO https://github.com/inboxorcist/inboxorcist/releases/latest/download/inboxorcist-darwin-arm64.tar.gz
tar -xzf inboxorcist-darwin-arm64.tar.gz
cd inboxorcist
./inboxorcistIntel Mac:
curl -LO https://github.com/inboxorcist/inboxorcist/releases/latest/download/inboxorcist-darwin-x64.tar.gz
tar -xzf inboxorcist-darwin-x64.tar.gz
cd inboxorcist
./inboxorcistx64 (most servers):
curl -LO https://github.com/inboxorcist/inboxorcist/releases/latest/download/inboxorcist-linux-x64.tar.gz
tar -xzf inboxorcist-linux-x64.tar.gz
cd inboxorcist
./inboxorcistARM64 (Raspberry Pi, AWS Graviton):
curl -LO https://github.com/inboxorcist/inboxorcist/releases/latest/download/inboxorcist-linux-arm64.tar.gz
tar -xzf inboxorcist-linux-arm64.tar.gz
cd inboxorcist
./inboxorcist- Download
inboxorcist-windows-x64.zip - Extract the ZIP file
- Open the extracted folder
- Double-click
inboxorcist.exe
Option 3: Docker
If you prefer Docker:
# Create a directory
mkdir inboxorcist && cd inboxorcist
# Create docker-compose.yml with pre-built image
cat > docker-compose.yml << 'EOF'
services:
inboxorcist:
image: ghcr.io/inboxorcist/inboxorcist:latest
ports:
- "6616:6616"
environment:
- JWT_SECRET=${JWT_SECRET}
- ENCRYPTION_KEY=${ENCRYPTION_KEY}
volumes:
- inboxorcist-data:/usr/src/app/data
volumes:
inboxorcist-data:
EOF
# Generate secrets
cat > .env << EOF
JWT_SECRET=$(openssl rand -base64 32)
ENCRYPTION_KEY=$(openssl rand -hex 32)
EOF
# Start Inboxorcist
docker compose up -dOpen http://localhost:6616/setup to configure Google OAuth via the web UI.
Configure Google OAuth
On first run, you'll be redirected to the setup page to configure Google OAuth.
See the Google OAuth Setup guide for step-by-step instructions on creating OAuth credentials.
Configuration options:
- Web UI (Recommended) - Enter credentials at
/setupon first run - Environment variables - Set
GOOGLE_CLIENT_IDandGOOGLE_CLIENT_SECRETin.env
What Gets Started
| Method | URL | Database | Queue |
|---|---|---|---|
| Binary | http://localhost:6616 | SQLite (default) or PostgreSQL | In-memory |
| Docker | http://localhost:6616 | PostgreSQL | In-memory |
Connect Your Gmail
- Open http://localhost:6616 in your browser
- Click Connect Gmail
- Sign in with your Google account
- Grant the requested permissions
- Start cleaning your inbox!
Stopping the Application
Binary:
# Press Ctrl+C in the terminalDocker:
# Stop containers (keeps data)
docker compose down
# Stop and remove all data
docker compose down -v