Installation & Deployment¶

This guide outlines the steps to install and deploy Condor.

Important

Docker is the recommended installation method for most users as it handles all dependencies automatically. The Source/Conda method is intended for developers or advanced users who need to modify the code.

✅ Prerequisites¶

Before you begin, ensure you have the following ready:

Docker & Docker Compose (for Docker method).
Python 3.11+ & Conda (for Source method).
A running Hummingbot API instance.
A Telegram Bot Token from @BotFather.

🐳 Option 1: Docker (Recommended)¶

1. Clone the Repository¶

git clone https://github.com/hummingbot/condor.git
cd condor

2. Configure Environment¶

Run the setup script to generate your .env file.

./setup-environment.sh

Required Inputs:

TELEGRAM_TOKEN: Your bot token.
AUTHORIZED_USERS: Comma-separated list of allowed Telegram User IDs (e.g., 123456789,987654321).

3. Launch Condor¶

docker compose up -d

🐍 Option 2: Source (Developers)¶

Use this method if you want to run Condor directly from the source code.

Clone the Repository¶

# Clone the repository
git clone https://github.com/hummingbot/condor.git
cd condor

Create Conda Environment¶

conda env create -f environment.yml
conda activate condor

Configure Environment¶

Run the setup script to generate your .env file.

./setup-environment.sh

Run the Bot¶

python main.py

🛠️ Post-Installation Configuration¶

Getting Your Telegram User ID: 1. Start the bot with /start 2. If not authorized, the bot will display your User ID 3. Add your User ID to TELEGRAM_ALLOWED_IDS

2. API Servers Configuration (`servers.yml`)¶

Create servers.yml to define your Hummingbot instances:

default_server: main
servers:
  main:
    host: localhost
    port: 8000
    username: admin
    password: admin
    enabled: true

  remote:
    host: 192.168.1.100
    port: 8000
    username: admin
    password: admin
    enabled: true

Note: You can also configure servers directly through the bot's /config menu.

First-Time Setup¶

Start the bot: Send /start to your bot in Telegram
Verify access: Ensure your User ID is in TELEGRAM_ALLOWED_IDS
Configure servers: Use /config → 🔌 API Servers to add your Hummingbot instances
Add credentials: Use /config → 🔑 API Keys to connect exchange accounts
Deploy Gateway (optional): Use /config → 🌐 Gateway to set up DEX trading