OpenMates Docs Open Chat

Self-Hosting

Self-Hosting Run your own OpenMates instance with full control over your data and infrastructure. Guide Setup & Installation - CLI-first guide for installing...

[T:documentation.sender_name]

Self-Hosting

Run your own OpenMates instance with full control over your data and infrastructure.

Guide

The setup guide covers:

  • Prerequisites and system requirements
  • Installing the CLI with npm install -g openmates
  • Running openmates server install
  • Starting the backend and web app with openmates server start
  • Signup modes for invite codes, email-domain allowlists, or both
  • Optional AI provider keys and no-key startup behavior
  • Production deployment with Caddy reverse proxy
  • Management commands
  • Troubleshooting common issues

Requirements

  • A Linux server (Ubuntu/Debian recommended)
  • Docker and Docker Compose
  • Optional AI provider API key when you want AI chat/model processing
  • A domain name (for production deployment)