User Guide

Clear steps to set up Octo on Windows and Linux.

⚙️ Windows Environment Variables

To make Octo commands available in CMD/PowerShell:

  1. Right-click This PC → Properties → Advanced system settings
  2. Click Environment Variables
  3. Add Octo installation path to PATH
  4. Restart your terminal

🛡️ Windows Firewall

Octo requires port 5000 to be open:

  1. Open Windows Defender Firewall
  2. Go to Advanced Settings
  3. Create new inbound & outbound rules for port 5000

🐧 Linux Docker Permissions

To run Docker without sudo:

  1. sudo usermod -aG docker $USER
  2. Log out and log back in

🚀 First Steps

After setup, run:

octo run main.py

If this runs successfully, Octo is ready!

Next Steps

Boost your productivity with Octo.