Hummingbot Deploy

repository·main·Indexed 42 days ago

https://github.com/hummingbot/deploy

Automated installation scripts for Condor, a Telegram-based trading bot, and the Hummingbot API. Supports setup on Mac, Linux, and Windows via WSL2, including Docker-based deployment for the API and update procedures via Telegram or terminal.

Tokens
961
Snippets
5
Records
7
Agent score
3%

What's inside Hummingbot Deploy

  1. Read Condor logs using tmux

    main

    If the bot is not responding or you see errors, you can view the live logs using tmux.

    1. Run the following command to attach to the session:
      tmux attach -t condor
    2. To exit the log view without stopping the bot, use the tmux detach sequence: Press Ctrl+B, release, then press D.
    tmux attach -t condor
  2. Install Condor and Hummingbot API

    main

    To install Condor (a Telegram trading bot) and optionally the Hummingbot API (a web service), use the automated installer.

    Prerequisites

    • OS: Mac or Linux (Windows users must use WSL2 with Ubuntu).
    • Docker: If installing the Hummingbot API, Docker Desktop (Mac/Windows) or Docker (Linux) must be installed and running before starting.
    • Terminal: An open terminal session.

    Installation Steps

    1. Open Terminal and navigate to an empty folder (e.g., cd Desktop).
    2. Run the following command:
    curl -fsSL https://raw.githubusercontent.com/hummingbot/deploy/main/setup.sh | bash
    1. Follow the interactive prompts to provide your Telegram bot token and Telegram user id. You will be asked if you want to install the Hummingbot API on the same machine during this process.
  3. Verify installation and access the API

    main

    1. Verify Condor is running

    Open Telegram and check your Condor bot chat. You should see the message: Condor is online and ready.

    2. Access the Hummingbot API

    If you installed the API, you can access the documentation and interface in your browser at: http://localhost:8000/docs

  4. Install only Hummingbot API

    main

    Use this command if you want to deploy the Hummingbot API and its database stack on a standalone machine (like a VPS or remote server) without installing the Condor Telegram bot.

    Requirement: Docker must be installed and running on the target server before execution.

    curl -fsSL https://raw.githubusercontent.com/hummingbot/deploy/main/setup.sh | bash -s -- --hummingbot-api
  5. Manual installation of Condor and Hummingbot API

    main

    If the automated curl installer fails, use these manual steps.

    Manual Condor Install

    1. Clone the Condor repository: git clone https://github.com/hummingbot/condor
    2. Navigate to the folder: cd condor
    3. Run make install
    4. Start the app with make run

    Manual Hummingbot API (Docker) Install

    git clone --depth 1 https://github.com/hummingbot/hummingbot-api.git hummingbot-api
    cd hummingbot-api && make setup && docker compose pull && make deploy
  6. Update Condor to the latest version

    main

    There are two ways to update Condor:

    Method 1: Via Telegram (Easiest)

    If you are the admin user configured during setup, simply open your Condor bot chat in Telegram and send the command: /update

    This will check for updates and allow you to restart the bot using buttons within Telegram.

    Method 2: Via Terminal (Manual)

    Navigate to the folder where the condor directory is located and run:

    curl -fsSL https://raw.githubusercontent.com/hummingbot/deploy/main/setup.sh | bash -s -- --upgrade
  7. Troubleshoot Condor installation

    main

    Common issues and solutions:

    • Docker errors: Ensure Docker Desktop (Mac/Windows) or the Linux Docker service is started and running, then retry the installation command.
    • Telegram bot is silent: Use tmux attach -t condor to check the logs. Verify that the Telegram bot token and admin id entered during setup are correct.
    • Installation fails: If the curl command fails, you may need to perform a manual installation (see manual backup section).