TrueNAS SCALE

Prerequisites

• Your TrueNAS system must be running SCALE version 24.10 (Electric Eel) or newer.
• You must have an existing ZFS dataset created to store your Spokes application data (e.g., /mnt/tank/app-data/spokes).
• You have decided on your ports.

Deploying via “Custom App”

To deploy Spokes on TrueNAS SCALE:

1. Log in to your TrueNAS SCALE web interface.
2. Navigate to Apps in the left sidebar.
3. Click the Discover Apps button.
4. Click Custom App in the top right.
5. Enter spokes as the Application Name.
6. Provide the following Docker Compose YAML:

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:
      - /mnt/YOUR_POOL/YOUR_DATASET/spokes:/data
    environment:
      - SPOKES_MASTER_PASSWORD=YourSecureMasterPasswordHere

7. Customize the /mnt/YOUR_POOL/... path and the master password.
8. Click Install. Once running, navigate to http://<your-truenas-ip>:8080 (or whichever Web UI port you mapped) to complete the Setup Wizard!

Alternative: Portainer or Dockge

Many TrueNAS SCALE Electric Eel users prefer to install Portainer or Dockge as a Custom App first, and then manage all their Docker Compose stacks from there. If you are using Portainer on TrueNAS, follow our Portainer Deployment Guide instead!

---

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.