Installation Guide

This guide will help you install and set up SanctumOS on your system. SanctumOS can be installed as a complete system or as individual modules based on your needs.

🎯 Installation Options

Option 1: Sanctum Installer (Early Alpha)

The Sanctum Installer automates setup for the full Sanctum stack. The kernel loader is the primary payload, targeting WSL, Ubuntu, and Raspbian systems.

Automated Setup: Handles dependencies and configurations
Integrated Environment: Configures components to work together
Plugin Management: Manages plugins and their configurations
Environment Variables: Sets up all necessary environment variables

Status: Early alpha — expect breaking changes, incomplete features, and limited platform testing. Not yet recommended for production.

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

git clone https://github.com/sanctumos/installer.git cd installer

Follow the README for your platform


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Option 2: Individual Module Installation

For development, testing, or custom deployments, you can install modules individually:

📋 Prerequisites

System Requirements

Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
Python: 3.8 or higher
Memory: 4GB RAM minimum, 8GB recommended
Storage: 2GB free space
Network: Internet connection for dependency installation

Additional Requirements by Module

Module	Additional Requirements
Sanctum Letta MCP	pip package manager
Broca-2	SQLite support, pip package manager
Sanctum Web Chat	PHP 7.4+ OR Python 3.8+, SQLite support, Web server

Required Software

Git: For cloning repositories
Python pip: Package manager
Virtual Environment: Python virtual environment support

Module Dependencies

Sanctum Letta MCP Dependencies


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

aiohttp>=3.8.0 aiohttp-cors>=0.7.0 python-dotenv==1.0.0 pydantic>=2.7.2,<3.0.0 mcp>=1.10.1


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Broca-2 Dependencies


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

telethon python-dotenv sqlalchemy aiohttp emoji rich typer pydantic markdown letta-client aiogram


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Sanctum Web Chat Dependencies

PHP Implementation:

PHP 7.4+ (no additional dependencies required)

Flask Implementation:


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Flask==2.3.3 Flask-CORS==4.0.0 python-dotenv==1.0.0


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

🚀 Quick Start

1. Choose Your Installation Method

Complete Installation

For a full SanctumOS deployment with all modules:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

git clone https://github.com/sanctumos/installer.git cd installer

Follow the README for your platform (WSL, Ubuntu, or Raspbian)


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Individual Module Installation

For specific modules only:

Sanctum Letta MCP:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Clone the repository

git clone https://github.com/sanctumos/smcp.git cd smcp

Create virtual environment

python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate

Install dependencies

pip install -r requirements.txt

Run the server

python smcp/mcp_server.py


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Broca-2:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Clone the repository

git clone https://github.com/sanctumos/broca.git cd broca

Install dependencies

pip install -r requirements.txt

Configure environment

cp .env.example .env

Edit .env with your settings

Run the application

python main.py


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Sanctum Web Chat:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Clone the repository

git clone https://github.com/sanctumos/broca-web-client.git cd broca-web-client

PHP Implementation

cd php/public php -S localhost:8080

OR Flask Implementation

cd python python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate pip install -r requirements.txt python run.py


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

2. Configuration

Environment Setup

Create a Sanctum home directory:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

mkdir ~/sanctum cd ~/sanctum

Create shared virtual environment

python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Agent Configuration

For each AI agent you want to run:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Create agent-specific directory

mkdir ~/sanctum/agent-{uuid} cd ~/sanctum/agent-{uuid}

Clone Broca-2 for this agent

git clone https://github.com/sanctumos/broca.git broca

Configure agent settings

cp broca/.env.example .env

Edit .env with your agent configuration


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

3. Verification

Test Installation

Verify that all components are working:

Sanctum Letta MCP:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Test server startup

cd ~/sanctum/smcp python smcp/mcp_server.py --help

Test server health

curl -X POST http://localhost:8000/messages/ \ -H "Content-Type: application/json" \ -d '{"jsonrpc": "2.0", "method": "ping", "id": 1}'


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Broca-2:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Test application startup

cd ~/sanctum/agent-{uuid} python main.py --help

Test CLI tools

python -m cli.btool settings show python -m cli.btool queue list


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Sanctum Web Chat:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Test web chat widget

curl -X POST "http://localhost:8080/api/v1/?action=messages" \ -H "Content-Type: application/json" \ -d '{"session_id":"test123","message":"Hello world"}'

Test API endpoints (requires API key)

curl -H "Authorization: Bearer your-api-key" \ "http://localhost:8080/api/v1/?action=inbox"


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

🔧 Configuration

Global Configuration

Create a global configuration file:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

~/sanctum/config.json

{ "sanctum_home": "~/sanctum", "shared_venv": "~/sanctum/venv", "default_agent_config": { "message_mode": "live", "queue_refresh": 5, "debug_mode": false } }


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Agent-Specific Configuration

Each agent has its own configuration:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

~/sanctum/agent-{uuid}/.env

AGENT_ENDPOINT=https://your-agent-api.com AGENT_API_KEY=your-api-key DATABASE_URL=sqlite:///sanctum.db DEBUG_MODE=false


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Module Configuration

Each module can be configured independently:

Sanctum Letta MCP Configuration

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Environment Variables

MCP_HOST=0.0.0.0 # Server host binding MCP_PORT=8000 # Server port MCP_PLUGINS_DIR=smcp/plugins # Plugins directory path

Security Options

python smcp/mcp_server.py --host 127.0.0.1 # localhost-only python smcp/mcp_server.py --allow-external # external access python smcp/mcp_server.py --port 9000 # custom port


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Broca-2 Configuration

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Environment Variables

AGENT_ENDPOINT=https://your-agent-api.com AGENT_API_KEY=your-api-key DATABASE_URL=sqlite:///sanctum.db DEBUG_MODE=false

Multi-Agent Setup

mkdir ~/sanctum/broca2/agent-{uuid} cd ~/sanctum/broca2/agent-{uuid} cp ../.env.example .env cp ../settings.json .

Edit agent-specific configuration


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Sanctum Web Chat Configuration

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Environment Variables

WEB_CHAT_API_KEY=your-secure-api-key WEB_CHAT_ADMIN_KEY=your-secure-admin-key WEB_CHAT_DEBUG=false WEB_CHAT_DATABASE_URL=sqlite:///web_chat.db WEB_CHAT_RATE_LIMIT=1000

Broca-2 Plugin Integration

export WEB_CHAT_API_URL=http://localhost:8080 export WEB_CHAT_API_KEY=your-api-key export WEB_CHAT_POLL_INTERVAL=5


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

🐳 Docker Installation

Docker Compose

For containerized deployment:

# docker-compose.yml
version: '3.8'
services:
  sanctum-mcp:
    build: ./smcp
    ports:
      - "8000:8000"
    environment:
      - MCP_PORT=8000
      - MCP_HOST=0.0.0.0
  
  broca-agent:
    build: ./broca
    environment:
      - AGENT_ENDPOINT=${AGENT_ENDPOINT}
      - AGENT_API_KEY=${AGENT_API_KEY}
    depends_on:
      - sanctum-mcp
  
  web-chat:
    build: ./broca-web-client
    ports:
      - "8080:8080"
    environment:
      - WEB_CHAT_API_KEY=${WEB_CHAT_API_KEY}
    depends_on:
      - broca-agent

docker-compose.yml

version: '3.8' services: sanctum-mcp: build: ./smcp ports:

environment:

"8000:8000"
MCP_PORT=8000
MCP_HOST=0.0.0.0

broca-agent: build: ./broca environment:

depends_on:

AGENT_ENDPOINT=${AGENT_ENDPOINT}
AGENT_API_KEY=${AGENT_API_KEY}
sanctum-mcp

web-chat: build: ./broca-web-client ports:

environment:

depends_on:

"8080:8080"
WEB_CHAT_API_KEY=${WEB_CHAT_API_KEY}
broca-agent


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Docker Commands

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Build and start all services

docker-compose up -d

View logs

docker-compose logs -f

Stop services

docker-compose down


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

🔒 Security Configuration

API Keys

Generate strong API keys for all modules:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Generate API keys

openssl rand -hex 32 # For Sanctum Letta MCP openssl rand -hex 32 # For Broca-2 openssl rand -hex 32 # For Sanctum Web Chat


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Network Security

Configure firewall rules:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Allow only necessary ports

ufw allow 8000 # Sanctum Letta MCP ufw allow 8080 # Sanctum Web Chat ufw deny 22 # SSH (if not needed)


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

SSL/TLS

Set up SSL certificates for production:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Using Let's Encrypt

certbot --nginx -d your-domain.com


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

📊 Monitoring Setup

Log Configuration

Configure logging for all modules:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Create log directories

mkdir -p ~/sanctum/logs/{mcp,broca,web-chat}

Configure log rotation

sudo nano /etc/logrotate.d/sanctum


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

Health Checks

Set up health monitoring:

git clone https://github.com/sanctumos/installer.git
cd installer
# Follow the README for your platform

Create health check script

cat > ~/sanctum/health-check.sh << 'EOF' #!/bin/bash

Check Sanctum Letta MCP

curl -f -X POST http://localhost:8000/messages/ \ -H "Content-Type: application/json" \ -d '{"jsonrpc": "2.0", "method": "ping", "id": 1}' || exit 1

Check Broca-2

ps aux | grep "python.main.py" || exit 1

Check Sanctum Web Chat

curl -f http://localhost:8080/api/v1/?action=health || exit 1 EOF

chmod +x ~/sanctum/health-check.sh

### Option 2: Individual Module Installation For development, testing, or custom deployments, you can install modules individually: - Sanctum Letta MCP Installation - Broca-2 Installation - Sanctum Web Chat Installation ## 📋 Prerequisites ### System Requirements - Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+) - Python: 3.8 or higher - Memory: 4GB RAM minimum, 8GB recommended - Storage: 2GB free space - Network: Internet connection for dependency installation ### Additional Requirements by Module Module Additional Requirements Sanctum Letta MCP pip package manager Broca-2 SQLite support, pip package manager Sanctum Web Chat PHP 7.4+ OR Python 3.8+, SQLite support, Web server ### Required Software - Git: For cloning repositories - Python pip: Package manager - Virtual Environment: Python virtual environment support ### Module Dependencies #### Sanctum Letta MCP Dependencies

🚨 Troubleshooting

Common Issues

Port Conflicts

If you encounter port conflicts:

git clone https://github.com/sanctumos/installer.git cd installer # Follow the README for your platform

Check what's using the port

lsof -i :8000 lsof -i :8080

Kill conflicting processes

kill -9

### Option 2: Individual Module Installation For development, testing, or custom deployments, you can install modules individually: - Sanctum Letta MCP Installation - Broca-2 Installation - Sanctum Web Chat Installation ## 📋 Prerequisites ### System Requirements - Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+) - Python: 3.8 or higher - Memory: 4GB RAM minimum, 8GB recommended - Storage: 2GB free space - Network: Internet connection for dependency installation ### Additional Requirements by Module Module Additional Requirements Sanctum Letta MCP pip package manager Broca-2 SQLite support, pip package manager Sanctum Web Chat PHP 7.4+ OR Python 3.8+, SQLite support, Web server ### Required Software - Git: For cloning repositories - Python pip: Package manager - Virtual Environment: Python virtual environment support ### Module Dependencies #### Sanctum Letta MCP Dependencies

Permission Issues

Fix permission problems:

git clone https://github.com/sanctumos/installer.git cd installer # Follow the README for your platform

Fix file permissions

chmod -R 755 ~/sanctum chown -R $USER:$USER ~/sanctum

### Option 2: Individual Module Installation For development, testing, or custom deployments, you can install modules individually: - Sanctum Letta MCP Installation - Broca-2 Installation - Sanctum Web Chat Installation ## 📋 Prerequisites ### System Requirements - Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+) - Python: 3.8 or higher - Memory: 4GB RAM minimum, 8GB recommended - Storage: 2GB free space - Network: Internet connection for dependency installation ### Additional Requirements by Module Module Additional Requirements Sanctum Letta MCP pip package manager Broca-2 SQLite support, pip package manager Sanctum Web Chat PHP 7.4+ OR Python 3.8+, SQLite support, Web server ### Required Software - Git: For cloning repositories - Python pip: Package manager - Virtual Environment: Python virtual environment support ### Module Dependencies #### Sanctum Letta MCP Dependencies

Dependency Issues

Resolve dependency problems:

git clone https://github.com/sanctumos/installer.git cd installer # Follow the README for your platform

Update pip

pip install --upgrade pip

Reinstall dependencies

pip install -r requirements.txt --force-reinstall

### Option 2: Individual Module Installation For development, testing, or custom deployments, you can install modules individually: - Sanctum Letta MCP Installation - Broca-2 Installation - Sanctum Web Chat Installation ## 📋 Prerequisites ### System Requirements - Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+) - Python: 3.8 or higher - Memory: 4GB RAM minimum, 8GB recommended - Storage: 2GB free space - Network: Internet connection for dependency installation ### Additional Requirements by Module Module Additional Requirements Sanctum Letta MCP pip package manager Broca-2 SQLite support, pip package manager Sanctum Web Chat PHP 7.4+ OR Python 3.8+, SQLite support, Web server ### Required Software - Git: For cloning repositories - Python pip: Package manager - Virtual Environment: Python virtual environment support ### Module Dependencies #### Sanctum Letta MCP Dependencies

Getting Help

If you encounter issues:

Check the Troubleshooting Guide
Review module-specific documentation
Check GitHub issues for known problems
Join community discussions

🔄 Updates

Updating SanctumOS

Keep your installation up to date:

git clone https://github.com/sanctumos/installer.git cd installer # Follow the README for your platform

Update Sanctum Letta MCP

cd ~/sanctum/smcp git pull origin main pip install -r requirements.txt

Update Broca-2

cd ~/sanctum/agent-{uuid}/broca git pull origin main pip install -r requirements.txt

Update Sanctum Web Chat

cd ~/sanctum/broca-web-client git pull origin main

Follow update instructions for your implementation

### Option 2: Individual Module Installation For development, testing, or custom deployments, you can install modules individually: - Sanctum Letta MCP Installation - Broca-2 Installation - Sanctum Web Chat Installation ## 📋 Prerequisites ### System Requirements - Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+) - Python: 3.8 or higher - Memory: 4GB RAM minimum, 8GB recommended - Storage: 2GB free space - Network: Internet connection for dependency installation ### Additional Requirements by Module Module Additional Requirements Sanctum Letta MCP pip package manager Broca-2 SQLite support, pip package manager Sanctum Web Chat PHP 7.4+ OR Python 3.8+, SQLite support, Web server ### Required Software - Git: For cloning repositories - Python pip: Package manager - Virtual Environment: Python virtual environment support ### Module Dependencies #### Sanctum Letta MCP Dependencies

Backup

Regular backups are important:

git clone https://github.com/sanctumos/installer.git cd installer # Follow the README for your platform

Backup configuration

tar -czf ~/sanctum-backup-$(date +%Y%m%d).tar.gz ~/sanctum

Backup databases

cp ~/sanctum/agent-/sanctum.db ~/sanctum/backups/


### Option 2: Individual Module Installation
For development, testing, or custom deployments, you can install modules individually:

- Sanctum Letta MCP Installation
- Broca-2 Installation
- Sanctum Web Chat Installation

## 📋 Prerequisites

### System Requirements
- Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
- Python: 3.8 or higher
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space
- Network: Internet connection for dependency installation

### Additional Requirements by Module





Module
Additional Requirements




Sanctum Letta MCP
pip package manager


Broca-2
SQLite support, pip package manager


Sanctum Web Chat
PHP 7.4+ OR Python 3.8+, SQLite support, Web server






### Required Software
- Git: For cloning repositories
- Python pip: Package manager
- Virtual Environment: Python virtual environment support

### Module Dependencies

#### Sanctum Letta MCP Dependencies

📚 Next Steps

After installation:

Configure your first agent - Set up agent endpoints and API keys
Test the system - Verify all components are working
Explore the modules - Learn about each module's capabilities
Build custom plugins - Extend the system with your own plugins
Deploy to production - Set up monitoring and security

SanctumOS Installation Guide - Get your AI agent communication platform up and running.