SPCBotSPCBot Docs

Features

Learn how features work in SPCBot and how to configure them for your team.

Visual Guide

Drop real screenshots into the paths below. This grid is rendered by src/app/docs/components/image-placeholder.tsx.

Dashboard Overview

Main dashboard with stats and recent deployments

public/docs/images/dashboard-overview.png

Server List

Connected servers and their health status

public/docs/images/servers-list.png

Deployment View

Live deployment logs and progress

public/docs/images/deployment-view.png
Speed: 30-60 seconds vs 3-5 minutes

Update changed files only without full container rebuild

What It Does

  1. Git Pull: Fast update of changed files only
  2. Update Modules: Reload changed Odoo modules
  3. Fast Restart: Restart Odoo without container rebuild

When to Use

  • Small code changes
  • Module updates
  • Configuration changes
  • NOT for database schema changes

API Endpoint

POST /organizations/:slug/projects/:projectId/environments/:id/quick-update

Clone Environment

Duplicate an entire environment including database, filestore, and configuration.

What Gets Cloned

  • Database (full pg_dump / pg_restore)
  • Filestore (Odoo attachments)
  • Configuration (non-secret env vars)
  • Git repository and branch
  • Secrets (must be reconfigured)

Clone Options

OptionDescription
NameNew environment name
ServerTarget server (can be different from source)
BranchOverride git branch (optional)

API Endpoint

POST /organizations/:slug/projects/:projectId/environments/:id/clone
Body: {
  "name": "staging-copy",
  "serverId": "optional-server-id",
  "branch": "optional-branch"
}

Auto Deploy

Automatically deploy when code is pushed to GitHub.

How It Works

  1. Push code to GitHub repository
  2. GitHub sends webhook to SPCBot
  3. SPCBot queues deployment job
  4. DeploymentWorker processes the job
  5. Instance updated automatically

Configuration

  • Enable Auto Deploy toggle per environment
  • Only triggers when environment is RUNNING
  • Set webhook URL in GitHub repository settings
Production Warning

Auto-deploy to production should be used with caution. Consider requiring manual approval for production environments.

Environment Variables

Configure per-instance settings securely with inline editing.

Variable Types

TypeStorageDisplay
RegularPlain textVisible value
SecretEncrypted (AES-256)Hidden (••••••••)
SystemEncryptedRead-only (e.g., _ODOO_MASTER_PASSWORD)

Odoo Configuration

Special ODOO_* variables are injected into odoo.conf:

  • ODOO_WORKERS=4 → Sets worker processes
  • ODOO_LOG_LEVEL=debug → Sets logging level
  • ODOO_LIMIT_MEMORY=8589934592 → Memory limits

Inline Editing Features

  • Double-click to edit any user variable
  • Enter to save, Escape to cancel
  • Blur auto-saves if value changed
  • Toggle secret checkbox during edit
  • Hover reveals edit button