Raspberry Pi

OpenAlgo on Raspberry Pi — Setup Guide

This guide helps you install and configure OpenAlgo on Raspberry Pi models 3, 4, or 5 (4GB+ RAM), preferably running Ubuntu 24.04+ server edition.

Hardware & OS Recommendations

• Raspberry Pi Model: 3, 4, or 5 (minimum 4GB RAM)

• SD Card: Recommended 128GB; minimum 64GB

• Operating System: Ubuntu 24.04+ Server edition (preferred)

• RPi official power adapter: Recommended to buy for stable power supply and avoid RPi abrupt shutdowns and restarts. Get Ubuntu images for Raspberry Pi

Initial System Preparation

1. Flash OS to SD Card

• Use Raspberry Pi Imager to prepare your SD card.

• Configure initial user, password, Wi-Fi details, etc.

2. First Boot & Access

• Insert SD card, power on Raspberry Pi.

• Connect HDMI to monitor/TV and USB keyboard or get the private IP from your router/AP and SSH to RPi instance :

  ssh <username>@<raspberry-pi-ip>

• Official Raspberry Pi SSH guide

3. Setup Swap

• Recommend swap size: max 4GB, min 2GB

  sudo fallocate -l 4G /swapfile
  sudo chmod 600 /swapfile
  sudo mkswap /swapfile
  sudo swapon /swapfile
  echo '/swapfile none swap sw 0 0' | sudo tee -a /etc/fstab

OpenAlgo Installation

Option 1: Using Official Install Script

• Visit: Install Instructions

• Follow the script prompts. (Typically involves downloading, running the script, and entering your details.)

Option 2: Docker-Based Setup (Recommended for advanced users)

1. Install Docker (Ubuntu/ARM)

Docker Ubuntu install guide

sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

2. Install Docker Buildx for ARM

docker buildx version

If not present, follow: https://docs.docker.com/buildx/working-with-buildx/#install-buildx

3. Get nginx Docker Image (reverse proxy)

docker pull nginx:latest

4. Clone the OpenAlgo Repo

git clone https://github.com/marketcalls/openalgo
cd openalgo

5. Build OpenAlgo Docker Image

docker build -t openalgo:latest .

6. Configure Environment

• Copy .sample.env as .env and fill in broker API key, secret, and client ID

  cp .sample.env .env
  vi .env

7. Use docker-compose.yaml

• Edit/verify docker-compose.yaml inside /openalgo

• If you have build the docker image in previous step, you can comment the build and its nested tags (using #) in docker-compose.yaml file.

• Launch services:

  docker-compose up -d

8. Configure Nginx Reverse Proxy

• Reference: Install Multi-Script Example

• Typical location blocks for nginx:

  location / {
      proxy_pass http://localhost:<openalgo-port>;
      proxy_set_header Host $host;
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header X-Forwarded-Proto $scheme;
  }

• Adapt your domain/server settings accordingly.

Persistent Storage (Recommended Practice)

I prefer to separate out the runtime files and folders from the github cloned folder and keep them separate. So if you build the docker image as in above step #5, you can very well take the docker-compose.yaml in a separate working folder structure and have your own versions of .env file.

• Create and mount volumes under /work for logs, keys, strategies, etc.

  /work
    /storage
       /openalgo
           docker-compose.yaml
           .env
           applogs/
           logs/
           keys/
           strategies/
           db/

• Update docker-compose.yaml example:

  volumes:
    - /work/storage/openalgo/keys:/openalgo/keys
    - /work/storage/openalgo/strategies:/openalgo/strategies
    # Add other mounts as required

Securing your setup

A. Basic Server Protection (iptables, fail2ban)

1. Install iptables

sudo apt-get update
sudo apt-get install iptables

• Example: Allow SSH and HTTP(S), block others:

  sudo iptables -A INPUT -p tcp --dport 22 -j ACCEPT
  sudo iptables -A INPUT -p tcp --dport 80 -j ACCEPT
  sudo iptables -A INPUT -p tcp --dport 443 -j ACCEPT
  sudo iptables -A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT
  sudo iptables -A INPUT -j DROP
  sudo iptables-save | sudo tee /etc/iptables/rules.v4

• iptables guide

2. Install fail2ban

sudo apt-get install fail2ban

• Enable default jails for SSH, edit /etc/fail2ban/jail.local for customization.

• Start and enable service:

  sudo systemctl enable fail2ban
  sudo systemctl start fail2ban

• fail2ban documentation

• Example setup

B. Using Cloudflare for Reverse Proxy & Security

• Register at Cloudflare.

• Add Your Domain:

  • Point your domain's DNS to Cloudflare's nameservers.

  • Set up proxy status for your domain so Cloudflare sits between users and your Pi.

• HTTPS and SSL:

  • Use Cloudflare’s “Flexible SSL” or, for end-to-end encryption, generate origin certificates on Cloudflare and install them behind Nginx.

• Firewall Rules & Monitoring:

  • Enable Cloudflare Web Application Firewall (WAF).

  • Set up custom routes, rate limiting, and security rules.

  • Cloudflare dashboard security settings

• Analytics & DDoS Protection:

  • Monitor connection health and traffic patterns through Cloudflare Analytics.

• Cloudflare Nginx integration guide

---

Useful References

• OpenAlgo GitHub

• OpenAlgo Documentation

• Docker Install Ubuntu

• Nginx Reverse Proxy Setup

• Persistent Volumes Example

• IPTables Guide

• fail2ban documentation

• Cloudflare dashboard security settings

• Cloudflare Nginx integration guide

OpenAlgo is now ready on your Raspberry Pi! Start building and deploying your trading strategies.