Portainer Templates logo

Portainer Templates

LiveSwitch (swarm) LiveSwitch (swarm)

Media

A basic LiveSwitch stack with gateway, caching, database and media server

Configuration

Type
Swarm
Platform
linux
Env vars
POSTGRES_PASSWORD=''
Source
Repo

Template by portainer·Source

Services

gateway

Configuration

Image
frozenmountain/liveswitch-gateway:latest
Ports
8080:80809090:90908443:844310443:10443
Env vars
CONNECTIONSTRINGS:DEFAULT=postgres://postgres:${POSTGRES_PASSWORD}@postgres:5432/postgresCONNECTIONSTRINGS:CACHE=redis://redis
Restart
always

Image details

Pulls: 410k
User: frozenmountain
Created: Mar 20, 2020
Updated: 14 days ago
Status: active

media

Configuration

Image
frozenmountain/liveswitch-media-server:latest
Env vars
CONNECTIONSTRINGS:DEFAULT=postgres://postgres:${POSTGRES_PASSWORD}@127.0.0.1:5432/postgresCONNECTIONSTRINGS:CACHE=redis://127.0.0.1SERVICEBASEURL=http://127.0.0.1:8080
Restart
always

Image details

Pulls: 320k
User: frozenmountain
Created: Mar 20, 2020
Updated: 14 days ago
Status: active

redis

Configuration

Image
redis
Ports
6379:6379
Restart
always

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

postgres

Configuration

Image
postgres
Ports
5432:5432
Env vars
POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
Restart
always

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 2 hours ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying LiveSwitch (swarm)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select LiveSwitch (swarm), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The swarm stack file this template deploys, straight from its repo:

# Taken from https://github.com/jvenema/liveswitch-docker-compose/blob/main/docker-compose.yml
version: "3"

services:
  gateway:
    image: frozenmountain/liveswitch-gateway:latest
    restart: 'always'
    ports:
      - "8080:8080"
      - "9090:9090"
      - "8443:8443"
      - "10443:10443"
    environment:
      - CONNECTIONSTRINGS:DEFAULT=postgres://postgres:${POSTGRES_PASSWORD}@postgres:5432/postgres
      - CONNECTIONSTRINGS:CACHE=redis://redis
    networks: 
      - liveswitch
  media:
    # media server is super verbose...
    #logging:
    #  driver: none
    image: frozenmountain/liveswitch-media-server:latest
    restart: 'always'
    # necessary for media servers due to dynamic port management
    network_mode: 'host'
    ulimits: 
      nofile: 65535
    environment:
      # running on IP instead of by name due to the host network
      - CONNECTIONSTRINGS:DEFAULT=postgres://postgres:${POSTGRES_PASSWORD}@127.0.0.1:5432/postgres
      - CONNECTIONSTRINGS:CACHE=redis://127.0.0.1
      - SERVICEBASEURL=http://127.0.0.1:8080
  redis:
    image: redis
    restart: 'always'
    # ports needed to support meda server running on host network
    ports:
      - "6379:6379"
    networks: 
      - liveswitch
  postgres:
    image: postgres
    restart: 'always'
    networks: 
      - liveswitch
    # ports needed to support meda server running on host network
    ports:
      - "5432:5432"
    environment:
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
  
networks:
  liveswitch:

Or deploy it directly from the source:

git clone https://github.com/portainer/templates
cd templates
docker stack deploy -c stacks/liveswitch/docker-stack.yml liveswitch-swarm

More install options in our documentation.

Container Documentation

gateway Documentation

LiveSwitch Gateway releases.

media Documentation

LiveSwitch Media Server releases.

redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

Serve LiveSwitch (swarm) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying liveswitch-swarm.example.com to http://gateway:8080

Add this to your Caddyfile

liveswitch-swarm.example.com {
	reverse_proxy http://gateway:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8080
  • Stop the other service, or pick a different host port. In 8080:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, gateway can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Image won't pull

Test the pull directly on the host: docker pull frozenmountain/liveswitch-gateway:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Swarm stack

LiveSwitch (swarm) is a Swarm stack. Swarm is Docker's own way of running apps across more than one machine, so Portainer can spread it over a cluster and move it elsewhere if a server drops out.

The services

This stack is built from 4 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • gateway runs frozenmountain/liveswitch-gateway:latest
  • media runs frozenmountain/liveswitch-media-server:latest
  • redis runs redis
  • postgres runs postgres

Ports

A port is the door the app answers on. A mapping like 8080:8080 means it's reachable on port 8080 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8080 in a browser. It opens:

  • 8080:8080, likely the web interface
  • 9090:9090
  • 8443:8443
  • 10443:10443
  • 6379:6379
  • 5432:5432

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. LiveSwitch (swarm) takes 4 of them, all with defaults you can leave alone or tweak:

  • CONNECTIONSTRINGS:DEFAULT, defaults to postgres://postgres:POSTGRES_PASSWORD@127.0.0.1:5432/postgres
  • CONNECTIONSTRINGS:CACHE, defaults to redis://127.0.0.1
  • SERVICEBASEURL, defaults to http://127.0.0.1:8080
  • POSTGRES_PASSWORD, pulled from your own environment

Restart policy

The restart policy here is always, so Docker brings LiveSwitch (swarm) back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like gateway) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set LiveSwitch (swarm) up. Add the template list to Portainer once, then deploying LiveSwitch (swarm) is a click rather than a wall of config.