Step 2 - Unraid

Spokes can be deployed seamlessly on your Unraid server. Spokes is available directly in the Unraid Community Applications store.

Deploying via Community Applications

Using the official template is the easiest and most reliable way to run Spokes on Unraid. It pre-configures all necessary ports, paths, and environment settings.

Prerequisites

• You have completed Step 1: Planning Your Deployment and have decided on your ports and secure master password.

Installation Steps

1. Log in to your Unraid Web UI.
2. Navigate to the Apps tab in the main header.
3. Search for Spokes in the search bar. You can also view the template on the Unraid App Store.
4. Click the Install button on the Spokes application card.
5. The container configuration page will open with the settings pre-populated:
   • App Data Path: By default, this maps to /mnt/user/appdata/spokes/ on your host. Change this if you prefer a different storage path.
   • Master Password (SPOKES_MASTER_PASSWORD): Enter the secure master password you prepared in Step 1. This is required to encrypt database credentials and keys.
   • Web UI Port: Mapped to host port 8080 by default. You can change this if port 8080 is already in use.
   • Voice TCP Fallback Port: Mapped to host port 7881 by default. (Must match 1-to-1 with container port).
   • Voice UDP Port Range: Mapped to host ports 50000-50499 by default. (Must match 1-to-1 with container ports).
6. Scroll to the bottom and click Apply.

Unraid will download the Spokes container image and start the application. Once finished, navigate to your Docker list, click the Spokes icon, and select WebUI (or visit http://<your-unraid-ip>:<Web-UI-Port>) to complete Step 3: The Setup Wizard!

---

Deploying Manually (Fallback)

If you prefer to configure the Docker container manually without the template:

1. Open your Unraid Web UI and navigate to the Docker tab.

2. Scroll to the bottom and click Add Container.

3. Toggle the Advanced View switch in the top right corner.

4. Configure the basic container settings:

   • Name: Spokes
   • Repository: ghcr.io/pcbeeqc/spokes:latest
   • Network Type: Bridge

5. Scroll down and click + Add another Path, Port, Variable, Label or Device to add each of the following mappings:

   1. Web UI Port

   • Config Type: Port
   • Name: Web UI Port
   • Container Port: 8080
   • Host Port: 8080 (or your preferred Web UI port)
   • Connection Type: TCP

   2. LiveKit TCP Fallback

   • Config Type: Port
   • Name: Voice TCP Fallback Port
   • Container Port: 7881
   • Host Port: 7881
   • Connection Type: TCP
   • Note: This must map 1-to-1.

   3. LiveKit UDP Range

   • Config Type: Port
   • Name: Voice UDP Port Range
   • Container Port: 50000-50499
   • Host Port: 50000-50499
   • Connection Type: UDP
   • Note: This must map 1-to-1.

   4. App Data Path

   • Config Type: Path
   • Name: App Data Path
   • Container Path: /data
   • Host Path: /mnt/user/appdata/spokes/
   • Access Mode: Read/Write

   5. Master Password Variable

   • Config Type: Variable
   • Name: Master Password
   • Key: SPOKES_MASTER_PASSWORD
   • Value: YourSecureMasterPasswordHere

6. Click Apply at the bottom of the page to download the image and start Spokes.

---

Changing Default LiveKit UDP Ports

If the default UDP port range (50000-50499) is already in use by another container on your Unraid server, you must change it so that voice and video features work correctly.

Why it matters: LiveKit uses WebRTC for real-time media, which requires a strict 1-to-1 NAT mapping. This means your Host Port and Container Port must be exactly the same. Furthermore, you must update the ports in both the Unraid Docker configuration and the Spokes Setup Wizard so that the internal server knows which ports to broadcast.

How to change UDP ports:

Because Unraid does not allow you to edit the container port on an existing template or container configuration, you must delete the existing mapping and re-add it with your custom range:

1. Remove the existing mapping: Locate the Voice UDP Port Range (or Voice UDP) configuration and click Remove.
2. Add the new custom range: Scroll to the bottom and click Add another Path, Port, Variable, Label or Device.
3. Configure the new 1-to-1 mapping: Set it up with your available port range (e.g., 51000-51499):
   • Config Type: Port
   • Name: Voice UDP Port Range
   • Container Port: 51000-51499
   • Host Port: 51000-51499
   • Connection Type: UDP
4. Click Add.
5. Apply changes: Click Apply at the bottom of the page to save and restart the container.
6. Update Spokes Setup: When you reach the Network configuration step in the Spokes Setup Wizard, change the LiveKit UDP Start Port and LiveKit UDP End Port to match the exact same range you configured in Unraid (e.g., Start: 51000, End: 51499).
   • Note: If you have already completed the Setup Wizard, you can edit this on a running server by going to Spokes settings —> System Setup.