Skip to content
Spokes Documentation

CasaOS

Deploying Spokes on CasaOS can be done manually using the Custom Install feature, as our integration with the official CasaOS App Store is currently pending.

Prerequisites

Section titled “Prerequisites”
  • A device running CasaOS.
  • You have decided on your ports and master password.

Deploying via Custom Install

Section titled “Deploying via Custom Install”

The easiest way to install Spokes on CasaOS is by using the Custom Install feature and importing a Docker Compose configuration.

Installation Steps

Section titled “Installation Steps”
  1. Log in to your CasaOS web interface.
  2. Click on the App Store icon on the dashboard.
  3. In the top right corner of the App Store window, click the Custom Install button.
  4. In the Custom Install dialog, click the Import button (top right corner, next to the close button).
  5. Paste the following Docker Compose YAML into the text area:
version: '3.8'


services:
  spokes:
    image: ghcr.io/pcbeeqc/spokes:latest
    container_name: spokes_server
    restart: unless-stopped
    ports:
      - "8080:8080"
      - "7881:7881"
      - "30000-30499:30000-30499/udp"
    volumes:
      - /DATA/AppData/spokes:/data
    environment:
      - SPOKES_MASTER_PASSWORD=YourSecureMasterPasswordHere
  1. Click Submit. CasaOS will automatically parse the YAML and populate the form fields.
  2. Customize the following fields in the populated form:
    • Icon URL: Paste https://raw.githubusercontent.com/PCBeeQC/unraid-templates/main/logo.png to get the official Spokes icon on your dashboard.
    • Web UI Port: Under Port Option, change the Host Port (default 8080) if you planned to run the Web UI on a different port.
    • Volume Path: Under Volumes, adjust the Host Path (default /DATA/AppData/spokes) if you want to store application data in a different folder.
    • Master Password: Under Environment Variables, replace YourSecureMasterPasswordHere with your secure master password.
  3. Click Save to begin the installation.

CasaOS will pull the image and create the container. Once running, you will see Spokes on your dashboard!

Next Steps

Section titled “Next Steps”

Now that your Spokes container is running, it’s time to secure it and configure your network:

  • Reverse Proxy Setup: Expose Spokes securely via HTTPS using Cloudflare Tunnels or Nginx Proxy Manager.
  • Network Routing: Configure port forwarding for LiveKit voice and video.
  • The Setup Wizard: Complete the initial configuration and set up your identity provider.