AICB Quickstart Guide
Get a production-ready AICB instance running in under 2 minutes. You can deploy using Docker Compose or install directly via Python (pip install aicb).
Choose Your Installation Method
- 🐳 Docker Compose (Recommended)
- 🐍 Python Package (pip)
1. Clone & Configure
# Clone the open-source repository
git clone https://github.com/sannex-01/aicb.git
cd aicb
# Copy environment variables template
cp .env.example .env
Edit .env with your preferred AI provider:
# Core Security
APP_SECRET=generate-a-strong-random-secret-key-here
LLM_PROVIDER=gemini
GEMINI_API_KEY=AIzaSy...
# Optional Database (Defaults to SQLite if omitted)
DATABASE_URL=postgresql+asyncpg://postgres:postgres@db:5432/aicb
2. Start Services
docker compose up -d
Verify that the containers are healthy:
docker compose ps
Your AICB assistant is now running at http://localhost:8422!
1. Install AICB via pip
AICB can be installed standalone without Docker on any machine running Python 3.10+:
pip install aicb
2. Run Preflight Diagnostics
Validate your environment and database connection:
aicb doctor
3. Start the Server
# Start with default SQLite database on port 8422
aicb start
# Or supply a custom PostgreSQL / MySQL database URL
aicb start --db-url "postgresql+asyncpg://user:password@localhost:5432/aicb" --port 8422
First-Run Setup Wizard
Once your server is running, navigate to http://localhost:8422/_/admin/setup in your browser.
- Create Administrator Account: Enter your Name, Email, and Master Password.
- Business Identity: Enter your Business Name and Currency (e.g.
NGN,USD,GHS,KES,EUR). - Master API Key: The wizard securely generates your platform's live API key (
aicb_live_...). - Permanent Idempotency Lockout: Once configured, the
/setuproute is permanently locked to protect against unauthorized resets.
Access the Admin Portal
Log in to the management dashboard at:
👉 http://localhost:8422/_/admin/login
From the Admin Dashboard, you can:
- 🤖 Customize your AI Assistant prompt & behavioral persona
- 📦 Add store products and configure automated order handling
- 💬 Connect Meta WhatsApp Cloud API, Telegram, or embed the Website Widget
- 👥 Manage human agent access groups, assignments, and conversation escalations