SPCBotSPCBotv1.0
Log In
SPCBotSPCBot Docs

Instances

Learn how instances 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
Platform › Instances

Instances (Environments) are isolated Odoo deployments running in Docker containers. Each instance has its own database, filestore, and configuration.

Instance States

StateDescriptionActions
RUNNINGActive and accessibleStop, Restart, Deploy, Quick Update
STOPPEDInactive, data preservedStart, Delete
DEPLOYINGDeployment in progressView Logs
ERRORDeployment failedView Logs, Retry

Available Actions

  • Deploy: Full deployment with git clone, container build, and DB init
  • Quick Update: Fast update without full rebuild (30-60s)
  • Clone: Copy instance to new environment
  • Start/Stop: Control instance state
  • Restart: Restart Odoo container
  • Rollback: Revert to previous deployment
  • Delete: Remove instance and free resources

Configuration

  • Technical Name: Unique identifier used for containers and DB
  • Display Name: Human-readable name shown in UI
  • Branch: Git branch to deploy
  • Auto Deploy: Enable automatic deploy on git push
  • Auto Restart: Automatically recover after a crash, host reboot, or external stop (on by default; see Auto Restart)
  • Database Placement & Version: Set once at creation — co-located (default), another of your own servers, or a managed database service — plus which PostgreSQL version to run (see Database Placement)
  • Environment Variables: Custom configuration per instance

API Endpoints

POST   /environments/:id/deploy              # Full deploy
POST   /environments/:id/quick-update        # Fast update
POST   /environments/:id/clone               # Clone environment
POST   /environments/:id/start             # Start instance
POST   /environments/:id/stop              # Stop instance
POST   /environments/:id/restart           # Restart instance
POST   /environments/:id/rollback            # Rollback deploy
DELETE /environments/:id                   # Delete instance

Access URLs

Once deployed, instances are accessible via:

  • Custom Domain: Configured in domain settings
  • SPCBot Subdomain: instance-name.spcbot.com
  • Direct IP: http://server-ip:allocated-port
PreviousProjectsNext Features