Rollout Server Env

This guide covers setting up the Python environment for the OmniBoxes rollout server. This is a lightweight installation that does not require a GPU or ML libraries.

Prerequisites

Python 3.10+
Conda or virtualenv (recommended)

Create Environment

# Create a new conda environment
conda create -n webgym python=3.10
conda activate webgym

Install Dependencies

Install WebGym with omnibox dependencies:
```
pip install -e ".[omnibox]"
```
This installs only the packages needed for the OmniBoxes rollout server: FastAPI, httpx, Playwright, Redis, Pillow, psutil, and Requests.
Tip

If you also need the RL training pipeline on the same machine, install everything at once:
```
pip install -e ".[all]"
```

Install Redis:

With sudo (Ubuntu/Debian):

sudo apt-get update
sudo apt-get install redis-server

Without sudo (compile from source):

wget https://download.redis.io/redis-stable.tar.gz
tar -xzvf redis-stable.tar.gz
cd redis-stable
make
export PATH="$(pwd)/src:$PATH"

To make the PATH change permanent, add it to your .bashrc:

echo 'export PATH="/path/to/redis-stable/src:$PATH"' >> ~/.bashrc
source ~/.bashrc

macOS:

brew install redis

Verify Redis is installed:

redis-cli --version

Install Playwright browsers and system dependencies:

playwright install chromium
playwright install-deps chromium

(Optional) Install nginx for production deployments:

For production deployments with external access, the --nginx flag sets up an nginx reverse proxy. This requires sudo access and nginx to be installed:
```
sudo apt-get install nginx
```

Verify Installation

# Check key packages
python -c "import fastapi; print('FastAPI OK')"
python -c "import playwright; print('Playwright OK')"
python -c "import redis; print('Redis OK')"
redis-cli --version

Launch the Server

cd omniboxes/deploy

# Local development (e.g. 128 instances)
python deploy.py 128

See Deployment for full deployment options and API usage.