Skip to main content
The fastest way to self-host Inbox Zero is with two commands: 
npx @inbox-zero/cli setup      # One-time setup wizard
npx @inbox-zero/cli start      # Start containers
Then open http://localhost:3000 (or your domain).
Prerequisites: Docker and Node.js v22+ must be installed.

​
What the CLI Does

  • setup downloads the Docker Compose file, creates your .env, and walks you through configuring Google/Microsoft OAuth and your AI provider. For manual configuration, see the Setup Guides.
  • start pulls the latest pre-built Docker image from ghcr.io/elie222/inbox-zero:latest and starts all containers (app, Postgres, Redis).

​
Install Options

You can also install the CLI globally instead of using npx: 
npm install -g @inbox-zero/cli
inbox-zero setup
inbox-zero start

​
CLI Command Reference

CommandDescription
inbox-zero setupOne-time setup wizard
inbox-zero startStart containers
inbox-zero stopStop containers
inbox-zero updatePull latest image and restart
inbox-zero logs -fFollow container logs
inbox-zero statusShow container status
inbox-zero configInteractive configuration editor
inbox-zero config set <key> <value>Set a config value
inbox-zero config get <key>Get a config value

​
Updating

To update to the latest version: 
inbox-zero update
Or manually with Docker Compose: 
docker compose pull web
NEXT_PUBLIC_BASE_URL=https://yourdomain.com docker compose --profile all up -d

​
Next Steps

Setup Guides

Manual configuration for Google OAuth, Microsoft OAuth, PubSub, and AI providers.

Self-Hosting Guide

Production deployment, Docker profiles, and scheduled tasks.

AWS Deployment

Deploy on AWS using EC2, Terraform, or AWS Copilot.

Troubleshooting

Solutions for common issues like OAuth errors, rate limiting, and more.