Skip to content

Running with Docker

There are two containers for running SyncLounge using Docker: LinuxServer.io's container and Starbix's container.

LinuxServer.io container

The LinuxServer.io container for SyncLounge is located at https://hub.docker.com/r/linuxserver/synclounge and full documentation can be found there.

If you are running linux, DockSTARTer supports this container and makes it quick and easy to get up and running with Docker. DockSTARTer SyncLounge documentation will help you get set up.

Advanced

Override Servers List

If you want to override the Servers List you'll need to create and mount your servers file.

  1. Create a folder to hold you configurations. EX - ~/docker_configs/SyncLounge/

  2. Create a file called servers.json in your SyncLounge config folder and populate it with servers.

    Note: Your servers.json file should NOT include "servers": prefix (that is for the settings file which isn't used here). Only [] and the server objects inside should be included.

  3. Add or update your container's volume mounts according to the below examples.

Docker command-line:

-v <PATH_TO_SYNCLOUNGE_CONFIG_FOLDER>/servers.json:/defaults/servers.json

Docker compose:

services:
  synclounge:
    volumes:
        - <PATH_TO_SYNCLOUNGE_CONFIG_FOLDER>/servers.json:/defaults/servers.json

Starbix container

The original Docker container for SyncLounge can be found on Docker Hub made by Starbix.

Note: If you have issues with the ENV variables in Settings, trying using the argument syntax instead for the environment variable syntax. E.g. - webroot instead of WEB_ROOT

The following tags are available:

  • latest / alpine: webapp and server based on alpine
  • server: only server based on alpine
  • dev: development version of webapp and server based on alpine
  • nginx: latest + nginx reverse proxy

To use the latest

docker run \
  --name=synclounge \
  -p 8088:8088 \
  -p 8089:8089 \
  -e DOMAIN=example.com \
  starbix/synclounge

To use a tagged version:

docker run \
  --name=plextogether_nginx \
  -p 80:80 \
  -e DOMAIN=example.com \
  starbix/synclounge:TAG

If you are running DockSTARTer, you can run this container by using overrides to add SyncLounge. Here is a sample override file:

version: "3.4"
services:
  synclounge:
    image: starbix/synclounge
    container_name: synclounge
    environment:
      - DOMAIN=synclounge.domain.tld
    logging:
      driver: json-file
      options:
        max-file: ${DOCKERLOGGING_MAXFILE}
        max-size: ${DOCKERLOGGING_MAXSIZE}
    ports:
      - 8088:8088
      - 8089:8089
    restart: unless-stopped
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - ${DOCKERCONFDIR}/synclounge/settings.json:/opt/synclounge/settings.json