Installation¶

This guide covers all methods to install PolyBot.

Requirements¶

Python: 3.11 or higher
OS: Linux, macOS, or Windows (WSL recommended)
Memory: 2GB RAM minimum
Disk: 500MB for installation + data

PyPI Installation (Recommended)¶

The simplest way to install PolyBot:

pip install polybot-trader

Or with uv (faster):

uv pip install polybot-trader

Verify Installation¶

polybot --version
polybot --help

Docker Installation¶

Docker is ideal for production deployments.

Quick Start¶

# Clone the repository
git clone https://github.com/cryptuon/polybot
cd polybot

# Copy environment template
cp .env.example .env
# Edit .env with your credentials

# Start all services
docker compose up -d

Services¶

The Docker Compose setup includes:

Service	Port	Description
`polybot`	8000	Main application
`prometheus`	9090	Metrics (optional)
`grafana`	3000	Dashboards (optional)

Enable monitoring with:

docker compose --profile monitoring up -d

Persistent Data¶

Data is stored in Docker volumes: - polybot-data: SQLite and DuckDB databases - polybot-logs: Application logs

From Source¶

For development or customization:

# Clone repository
git clone https://github.com/cryptuon/polybot
cd polybot

# Install with uv (recommended)
uv sync

# Or with pip
pip install -e ".[dev]"

Running from Source¶

# With uv
uv run polybot --help

# Or directly
python -m polybot --help

Building the Frontend¶

The Vue.js dashboard requires Node.js:

cd frontend
npm install
npm run dev     # Development server
npm run build   # Production build

Platform-Specific Notes¶

macOS¶

Install Python via Homebrew:

brew install python@3.11

Ubuntu/Debian¶

sudo apt update
sudo apt install python3.11 python3.11-venv

Windows¶

We recommend using WSL2 for the best experience:

Install WSL2 with Ubuntu
Follow Linux installation steps

Native Windows is supported but may have limitations with NNG sockets.

Post-Installation¶

After installation, you need to:

Configure credentials: See Configuration
Initialize databases: polybot db init
Set up authentication: polybot auth

Upgrading¶

PyPI¶

pip install --upgrade polybot-trader

Docker¶

docker compose pull
docker compose up -d

From Source¶

git pull
uv sync

Troubleshooting¶

Common Issues¶

ModuleNotFoundError: No module named 'polybot'

# Ensure you're in the virtual environment
source .venv/bin/activate

NNG socket errors on Windows

# Use WSL2 instead of native Windows
wsl --install

Permission denied for IPC sockets

# Check /tmp/polybot directory permissions
sudo chmod 777 /tmp/polybot

For more help, see FAQ or open an issue.