Skip to content
Spokes Documentation

Portainer

Deploying Spokes via Portainer is incredibly simple thanks to our custom App Template. This allows you to deploy Spokes with a single click natively within your Portainer dashboard.

Prerequisites

Section titled “Prerequisites”
  • A Linux host running Docker and Portainer.
  • A static IP assigned to your host machine on your local network (LAN).
  • You have decided which ports you want to use for the Web UI and LiveKit.

1. Add the Spokes App Template

Section titled “1. Add the Spokes App Template”

First, we need to tell Portainer where to find the Spokes configuration.

  1. Open your Portainer web interface.
  2. In the left sidebar, navigate to Settings.
  3. Scroll down to the App Templates section.
  4. In the Use custom templates field, paste the following URL: 
    https://spokes.sh/templates.json
  5. Click Save settings.

2. Deploy Spokes

Section titled “2. Deploy Spokes”

Now that Portainer knows about Spokes, deploying it takes just a few clicks.

  1. In the left sidebar, navigate to App Templates.
  2. You should now see the Spokes application in the list. (You can search for “Spokes” or look under the “Communication” category).
  3. Click on the Spokes template.
  4. A deployment screen will appear.
  5. Under the Env section, you will see a field for SPOKES_MASTER_PASSWORD.
    • Crucial: Enter a highly secure password here. This is the master encryption key used for secure channel escrows.
  6. Click the Deploy the stack button.

Portainer will now download the latest Spokes container and spin up your deployment.

Next Steps

Section titled “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.