Quick start for Windows
This quick start guide covers setting up an OpenCue deployment on Windows using Docker and docker-compose
Prerequisites
- Windows 10/11 with WSL2 enabled
- Docker Desktop for Windows
- Git for Windows
- Python 3.6+ (for CueGUI)
Setup Steps
1. Enable WSL2
If you haven’t already enabled WSL2:
- Open PowerShell as Administrator
- Run:
wsl --install - Restart your computer
2. Install Docker Desktop
- Download Docker Desktop for Windows
- Install and ensure WSL2 backend is enabled
- Start Docker Desktop
3. Clone the OpenCue repository
Open PowerShell or Command Prompt:
git clone https://github.com/AcademySoftwareFoundation/OpenCue.git
cd OpenCue
4. Start OpenCue services
docker-compose up -d
This starts:
- PostgreSQL database
- Cuebot server
- RQD (on the local machine)
5. Verify services are running
docker-compose ps
You should see all services in “Up” state.
6. Install Python dependencies
pip install pycue cuegui
7. Configure environment
Set the Cuebot host:
set CUEBOT_HOSTS=localhost
Or in PowerShell:
$env:CUEBOT_HOSTS = "localhost"
8. Launch CueGUI
cuegui
Testing the Setup
- In CueGUI, you should see your local machine listed as a host
- Submit a test job using CueSubmit:
cuesubmit
Troubleshooting
Docker not starting
- Ensure virtualization is enabled in BIOS
- Check that WSL2 is properly installed
- Restart Docker Desktop
CueGUI connection issues
- Verify CUEBOT_HOSTS is set correctly
- Check firewall settings for port 8443
- Ensure Cuebot container is running
Performance issues
- Allocate more resources to Docker Desktop in Settings
- Use WSL2 backend for better performance
Next Steps
For more detailed instructions, see the component-specific installation guides.