Step 2 - Unraid

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

Prerequisites

Before installing the container, ensure your network and reverse proxy are properly configured.

Network Configuration for Voice and Video

Spokes embeds the LiveKit engine for real-time communication. LiveKit requires strict 1-to-1 NAT port mapping for WebRTC to function correctly. This means the external port, the host port, and the container port must all match perfectly.

Router Configuration

You must configure port forwarding on your router:

• Forward TCP traffic coming to your WAN address on port 7881 to your Unraid server on port 7881.
• Forward UDP traffic coming to your WAN address on ports 50000 - 50499 to your Unraid server on ports 50000 - 50499.

(Note: You can choose different ports, but they must map 1-to-1)

Crucial Step

Ports must be mapped 1-to-1. For example, for the TCP fallback port: 7881 on your Router’s WAN IP must be forwarded to 7881 on your Host IP, which must be mapped to 7881 on your Container. If your router translates ports (e.g., forwarding WAN port 40000 to internal host port 50000), the voice and video connection will instantly fail.

Local Network Access

If your Unraid server is on the same local network as some of your users, you must enable NAT Reflection (Hairpin NAT) on your router.

Reverse Proxy Configuration

Your reverse proxy must be configured to properly handle real-time traffic:

• Websockets Support: This is crucial for real-time chat and LiveKit signaling. Must be enabled.
• Block Common Exploits: Recommended.
• HTTP/2 Support: Recommended.

---

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.

Installation Steps

1. Log in to your Unraid Web UI.
2. Navigate to the Apps tab in the main header.
3. Search for Spokes and click Install. You can also view the template on the Unraid App Store.
4. 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.

Configuring Voice Ports (LiveKit)

By default, the template maps the Voice TCP port to 7881 and the UDP range to 50000-50499. If you need to change these, you must delete the original mappings and create your own. Unraid does not allow you to edit the container port on an existing template mapping.

• Click “Remove” on both the Voice TCP Fallback Port and the Voice UDP Port Range.
• Click Add another Path, Port, Variable, Label or Device to add them back with your custom ports.

Wrong Configuration Example

In the example below, the Host ports for Voice TCP and UDP do not match the Container ports. This will break Voice and Video chat.

Correct Configuration Example

In the example below, the Host ports match the Container ports exactly (1-to-1).

5. 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>).

---

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.

---

Next Steps

Now that your container is running and accessible, you are ready to configure the application!

1. The Setup Wizard: Complete the initial configuration of your server, upload your logo, and configure your identity provider.
2. Casdoor Management: If you selected the Built-in Identity provider, learn how to create your first users and assign administrators.