Raspberry installation Guide
Note: This installation method is currently under testing and awaiting feedback from users. Should you run into problems or have found a fix to solve errors along the way, feel free to reach out through our Discord support channel.
You can install Hummingbot with either of the following options:
- Scripts: download and use automated install scripts.
- Manual: run install commands manually.
- Install Docker and change permissions.
curl -fsSL https://get.docker.com -o get-docker.sh sudo sh get-docker.sh sudo usermod -a -G docker $USER
- Start and automate docker.
sudo systemctl start docker && sudo systemctl enable docker
- Exit terminal/shell to refresh shell.
Warning: Restart terminal — Close and restart your terminal window to enable the correct permissions for
dockercommand before proceeding.
- Install Hummingbot:
# 1) Download Hummingbot install, start, and update script wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/create.sh wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/start.sh wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/update.sh # 2) Enable script permissions chmod a+x *.sh # 3) Create a hummingbot instance ./create.sh # 4) Pull Hummingbot ARM image when asked what version to use [ Enter Hummingbot version: [latest|development] (default = "latest")] dev-0.33.0-arm_beta
Note: This image
dev-0.33.0-arm_betaonly works for Raspberry Pi, other branches of Hummingbot are not built for ARM architecture.
This guide walks you through how to prepare your development environment and get started developing for Hummingbot.
Running Hummingbot on a Raspberry Pi has the same main benefit of running it on a cloud server: having a dedicated machine for Hummingbot. Raspberry Pi’s are relatively low cost, easy to set up, and, of course, don’t have the monthly charges associated with a cloud provider.
Read through our full blog post about Deploying Hummingbot on a Raspberry Pi.
The only way to currently install Hummingbot on a Raspberry Pi is by downloading the source files from GitHub and compiling and running from source. This adds a few more steps than downloading binaries or running from Docker, but below we have provided a step-by-step guide to walk you through the process.
Step 1. Install 64-bit Raspberry Pi OS
To run Hummingbot on a Raspberry Pi, a 64-bit OS is required. Raspberry Pi has a beta 64-bit version of the Raspberry Pi OS. You can download the OS from the Raspberry Pi website.
Step 2. Load the image file to your Raspberry Pi’s SD card
Raspberry Pi has an easy to follow guide with alternatives on how to load the SD card with a Raspberry Pi OS from different operating systems.
Step 3. Boot your Raspberry Pi
Insert your SD card into the Raspberry Pi and plug in the power source. From there, the first launch options will be prompted.
Step 1. Open the Raspberry Pi terminal
In the top left corner of the desktop, there is a shortcut that opens the terminal.
Step 2. Install Miniforge, Python and update alternatives
wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-aarch64.sh sh Miniforge3-Linux-aarch64.sh sudo apt-get install python3.7 sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 1
Step 3. Log out and Log back in to enable
This will make the
conda command available in shell / terminal.
Step 1. Create a conda environment for Hummingbot
conda create --name hummingbot
Step 2. Activate your conda environment
conda activate hummingbot
Step 3. Install the pip dependencies
pip install pandas cython cachetools aiohttp ruamel.yaml eth_account aiokafka sqlalchemy binance python-binance ujson websockets signalr-client-aio web3 prompt_toolkit 0x-order-utils 0x-contract-wrappers eth_bloom pyperclip telegram python-telegram-bot pyjwt numpy mypy_extensions pyblake2 pysha3 psutil ethsnarks-loopring
Step 1. Clone the Hummingbot repo from Github
git clone https://github.com/CoinAlpha/hummingbot.git
Step 2. Clean your Hummingbot directory and compile
cd hummingbot && ./clean && ./compile
Step 3. Run Hummingbot
SSH and VNC features are natively built into the Raspberry Pi and can easily be turned on in the Raspberry Pi configurations settings. By turning these on, you can access the Raspberry Pi from another computer by (1) using terminal to SSH, similar to how you would access a cloud server, or (2) using VNC to enable remote desktop access to the Raspberry Pi GUI. This is very convenient; after initial setup of the Raspberry Pi, you can simply unplug the monitor, keyboard and mouse, and just set the Raspberry Pi itself aside and just access it remotely going forward.
Step 1. Enable SSH and VNC on your Raspberry Pi
- Option 1: Terminal using raspi-config
Under Interfacing Options, enable SSH and VNC.
- Option 2: Access in Raspberry Pi Configuration
Select the menu in the top left corner of the screen then go to Preferences > Raspberry Pi configuration > Interfaces from there you will see options to enable SSH and VNC.
Tip: Set a default screen resolution in
7 Advanced Options>
A5 Resolutionto enable VNC access to the GUI whenever you boot the Raspberry Pi without a connected monitor. For troubleshooting please visit this link.
Setting a default resolution will avoid the following error:
Step 2. Get your Raspberry Pi’s IP address
ifconfig to get the IP address of your Raspberry Pi to enter into your VNC Viewer. For SSH, you can run
ssh pi@[ipaddress]. The IP address is the
inet address which is not the localhost IP address 127.0.0.1: