Skip to content
Spokes Documentation

Step 2 - TrueNAS SCALE

Prerequisites

Section titled “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 completed Step 1: Planning Your Deployment and have decided on your ports.

Deploying via “Custom App”

Section titled “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"
      - "50000-50499:50000-50499/udp"
    volumes:
      - /mnt/YOUR_POOL/YOUR_DATASET/spokes:/data
    environment:
      - SPOKES_MASTER_PASSWORD=YourSecureMasterPasswordHere
  1. Customize the /mnt/YOUR_POOL/... path and the master password.
  2. Click Install. Once running, navigate to http://<your-truenas-ip>:8080 (or whichever Web UI port you mapped) to complete Step 3: The Setup Wizard!