Step 2 - 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

• A device running CasaOS.
• You have completed Step 1: Planning Your Deployment and have decided on your ports and master password.

---

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

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"
      - "50000-50499:50000-50499/udp"
    volumes:
      - /DATA/AppData/spokes:/data
    environment:
      - SPOKES_MASTER_PASSWORD=YourSecureMasterPasswordHere

6. Click Submit. CasaOS will automatically parse the YAML and populate the form fields.
7. 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.
8. Click Save to begin the installation.

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

---

Deploying via the App Store (Soon)

Note

Spokes is not yet in the default CasaOS App Store directory. When it is, you can install Spokes with a single click using the steps below:

1. Log in to your CasaOS web interface.
2. Click on the App Store icon on the main dashboard.
3. In the search bar, type Spokes.
4. Click on the Spokes app and click Install.
5. CasaOS will automatically pull the container and set up the default ports and volumes.
6. Click the three dots on the Spokes app icon and select Settings to set your SPOKES_MASTER_PASSWORD environment variable and confirm your volume mapping.

---

Next Steps

Once the app is running, click the Spokes icon on your CasaOS dashboard (or navigate to http://<your-server-ip>:<Web-UI-Port>) to complete Step 3: The Setup Wizard!