Step 2 - 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

• A Linux host running Docker and Portainer.
• A static IP assigned to your host machine on your local network (LAN).
• You have completed Step 1: Planning Your Deployment and have decided on your ports.

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

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.

Important

The LiveKit UDP range (50000-50499/udp) and the TCP fallback port (7881) must map 1-to-1 between the host and the container. The template is pre-configured to do this automatically. Do not change these port mappings in the container settings unless you are an advanced user modifying your proxy setup.

3. Next Steps

Once the stack finishes deploying and the container is running, navigate to the web interface (e.g., http://your-server-ip:8080) to complete Step 3: The Setup Wizard!