Skip to content

Run Numi

Guides for instance owners and administrators. Start with Install Numi if you are setting up a new deployment.

Connect and deploy

  • Providers and endpoints: configure API credentials or connect a local model server.
  • ChatGPT subscription: connect an administrator's personal ChatGPT Plus or Pro plan via Sign in with ChatGPT.
  • Manage models: add selectable models, set the default model, and import or export your catalog.
  • Docker deployment: run the container service, back up persistent host paths, and configure an HTTPS reverse proxy.
  • Automatic deploys: follow a Git branch with a systemd timer and redeploy new commits without interrupting active turns.

Control behavior and access

  • Tool access: configure TOOLS_ALLOWLIST, TOOLS_DENYLIST, optional tool groups, and the code interpreter sandbox.
  • Manage skills: enable, disable, or add SKILL.md workflow folders for documents, spreadsheets, and analysis.
  • Memory: configure background extraction, consolidation, retention windows, and the memory model.
  • Context compaction: opt in to summarizing long conversations and tune per-provider context thresholds.
  • Files and PDFs: configure local OCR and PDF extraction limits.
  • Preferences and prompts: understand how system, session, and turn prompt layers are assembled.

Maintain the instance

  • Database migrations: back up chats.db and apply or roll back Alembic revisions.
  • Security: authentication, session tokens, origin checks, and execution sandboxing.
  • Privacy and data: local storage layout, external requests, exports, and deletion.

See the Configuration reference for every environment variable. Restart the server after changing .env settings; model catalog and skill switches in the Admin UI take effect immediately at runtime.