Skip to main content

​
System Requirements

Before installing Support Bot, ensure your system meets the following requirements:

​
Software Requirements

  • Python: 3.11 or higher
  • Docker: Latest stable version (for containerized deployment)
  • Docker Compose: v2.0 or higher
  • PostgreSQL: 18 or compatible version
  • Git: For cloning the repository

​
Hardware Requirements

  • RAM: Minimum 4GB (8GB recommended for production)
  • Storage: At least 10GB free disk space
  • CPU: 2+ cores recommended

​
Installation Methods

Support Bot can be installed using two methods:
  1. Docker Deployment (Recommended) - See Docker Deployment
  2. Manual Installation - For development or custom setups

​
Manual Installation

1

Clone the repository

git clone <repository-url>
cd support-bot
2

Install Python dependencies

Support Bot uses uv for dependency management:
pip install uv
uv sync
This will install all required dependencies from pyproject.toml.
3

Set up environment variables

Copy the example environment file and configure it:
cp .env.example .env
See Environment Configuration for details on required variables.
4

Start local services

Start PostgreSQL, pgvector, and Qdrant using Docker:
docker-compose up -d
This starts:
  • PostgreSQL (port 5434) - Main database
  • pgvector (port 5433) - Vector database
  • Qdrant (ports 6333, 6334) - Vector search engine
  • Adminer (port 8080) - Database management UI
5

Initialize the database

Run Alembic migrations to set up database tables:
cd src/api/db
alembic upgrade head
See Database Setup for more information.
6

Start the application

Set the Python path and start the backend server:
export PYTHONPATH=/path/to/support-bot
uv run uvicorn src.api.main:app --host 0.0.0.0 --port 8000
The API will be available at http://localhost:8000.

​
Verify Installation

After installation, verify that all services are running: 
curl http://localhost:8000/health

​
Next Steps

Docker Deployment

Deploy using Docker Compose for production

Database Setup

Configure PostgreSQL and run migrations

Environment Variables

Configure API keys and settings

Build docs developers (and LLMs) love

Get started for freeTalk to us