Skip to content

INDEX.md

Latest commit

 

History

History
287 lines (219 loc) · 11 KB

INDEX.md

File metadata and controls

287 lines (219 loc) · 11 KB
Raw
tags
index
home
aliases
Home
AutoBot Docs
cssclasses
home-note

AutoBot Documentation Index

Your data. Your AI.

AutoBot is a self-hosted AI platform you own: a small, solid core, a management layer that runs the hard infrastructure for you, and modules you install on top.

New here? Read The AutoBot Platform Model — the core → SLM → modules picture that everything below builds on.

Quick Start

Document Description
Getting Started Complete setup guide
Getting Started Index Installation guides by environment
Install in a VM VirtualBox, VMware, Hyper-V, KVM, WSL2
Browser VNC Quick Start VNC desktop access
System State Current system status
Glossary Terminology reference
Changelog Per-version release notes and unreleased fragments
Dependencies Dependency reference
Roadmap Product roadmap

Platform & Modules

Document Description
The AutoBot Platform Model Core → SLM management layer → modules
Why Self-Hosted The case for owning your AI platform
Service Lifecycle Manager (SLM) The management layer: deploy, operate, scale your AI infrastructure
AutoBot LLC Flagship module: an autonomous agent-company you install
Demos Feature walkthroughs and demo recording scripts

User Guides

Guide Description
User Docs Index All user documentation
01 - Installation Complete setup instructions
02 - Quick Start Get running in 5 minutes
03 - Configuration System configuration
04 - Troubleshooting Common issues and solutions
05 - Preferences User preferences guide
06 - Redis Management Redis service management

Developer Documentation

Document Description
Developer Docs Index All developer documentation
Developer Setup Developer onboarding
Architecture Guide System design principles
Process Flow Request handling flow
API Reference Complete API documentation
Configuration Reference Configuration options
AutoBot Reference IPs, playbooks, quick reference

Architecture

Document Description
Architecture Index All architecture documentation
Architecture Overview System architecture
Agent System Architecture Agent design
Memory Graph Architecture Knowledge graph
Distributed Architecture Role-based distributed design
Communication Architecture Service communication
Monitoring Architecture System monitoring
SSOT Configuration Single source of truth
ADR Index Architecture decision records

API Documentation

Document Description
API Index All API documentation
Comprehensive API Full API reference
API Endpoint Mapping Endpoint overview
WebSocket Integration Real-time communication
Terminal API Terminal endpoints
Redis Service API Redis management

Agent System

Document Description
Agents Index All agent documentation
Multi-Agent Architecture Agent coordination
Helper Agents Guide Specialized agents
Librarian Agents Guide Knowledge agents

Features

Document Description
Capability Catalog Full map of what AutoBot can do — including previously buried capabilities
Features Index All feature documentation
Knowledge Graph Knowledge management
Advanced Analytics Codebase analytics
Multimodal AI Multimodal integration
Log Forwarding Centralized logging
MCP Integration MCP tools

Security

Document Description
Security Index All security documentation
Security Implementation Core security
Service Auth Enforcement Authentication
Access Control Guide Authorization
TLS Certificate Management Certificate management

Infrastructure & Deployment

Document Description
Infrastructure Index All infrastructure documentation
Deployment Index All deployment documentation
Operations Index All operations documentation
Deployment Guide Full deployment
CI Pipeline Setup Continuous integration
Disaster Recovery Recovery procedures
Scaling Strategy Scaling strategy

Runbooks

Document Description
Runbooks Index All runbooks
Code Update Code update runbook
Deploy New Node Deploy new node
Emergency Recovery Emergency recovery
Rotate Certs Rotate TLS certificates

How-To Guides

Document Description
Guides Index All guides
SLM Bash Execution Execute bash commands via SLM
Visual Workflow Execution Parallel shell script workflows
RAG PDF Workflow RAG pipeline with PDF documents
Vision VNC UI Testing Automated UI testing via Vision
Distributed Task Failover Redis-backed task failover
Ansible Playbook Reference Ansible playbook reference

Workflow Management

Document Description
Workflow Index All workflow documentation
Workflow API API reference
Advanced Features Advanced capabilities
Workflow Orchestration System overview

Testing & Quality

Document Description
Testing Index All testing documentation
Testing Framework Test infrastructure
Performance Benchmarks Performance benchmarks
Frontend Tests UI/UX validation

Troubleshooting

Document Description
Troubleshooting Index All troubleshooting guides
Comprehensive Guide All issues
Ansible Deployment Failures Ansible failures
Frontend 404/401 Errors Frontend errors

Migration Guides

Document Description
Error Handling Migration Error handling
Async System Migration Async updates
LLM Interface Migration LLM changes

SDK

Document Description
SDK Index All SDK documentation
Python Quickstart Python SDK quickstart
TypeScript Quickstart TypeScript SDK quickstart

Frontend

Document Description
Frontend Index All frontend documentation
Design System Design system
Settings Panel Guide Settings panel guide

Implementation Reports

Document Description
Implementation Index All implementation reports
Refactoring Index All refactoring documentation

Planning & Historical

Document Description
Planning Index Historical planning documents
Development Index Development documentation
Plans Archive Dated implementation plans (Jan–Mar 2026)
ADR Index Architecture decision records

Configuration

Document Description
Environment Variables Environment config
VNC Port Configuration VNC port config

Key Directories

Directory Purpose
autobot-backend/ Main backend API
autobot-frontend/ User chat interface
autobot-slm-backend/ SLM backend
autobot-slm-frontend/ SLM dashboard
autobot_shared/ Shared utilities
autobot-infrastructure/ Deployment infrastructure