docker-synclounge/README.md

The LinuxServer.io team brings you another container release featuring:

• regular and timely application updates
• easy user mappings (PGID, PUID)
• custom base image with s6 overlay
• weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
• regular security updates

Find us at:

• Blog - all the things you can do with our containers including How-To guides, opinions and much more!
• Discord - realtime support / chat with the community and the team.
• Discourse - post on our community forum.
• Fleet - an online web interface which displays all of our maintained images.
• GitHub - view the source for all of our repositories.
• Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/synclounge

Synclounge is a third party tool that allows you to watch Plex in sync with your friends/family, wherever you are.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling linuxserver/synclounge should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Tag
x86-64	amd64-latest
arm64	arm64v8-latest
armhf	arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container.

docker

docker create \
  --name=synclounge \
  -e TZ=Europe/London \
  -e EXTERNAL_URL=your.domain.com \
  -e EXTERNAL_SERVER_PORT=80 `#optional` \
  -e AUTH_LIST=plexuser1,plexuser2,email1,machineid1 `#optional` \
  -e AUTOJOIN_ENABLED=false `#optional` \
  -e AUTOJOIN_ROOM=roomname `#optional` \
  -e AUTOJOIN_PASSWORD=password `#optional` \
  -p 8088:8088 \
  -p 8089:8089 \
  --restart unless-stopped \
  linuxserver/synclounge

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  synclounge:
    image: linuxserver/synclounge
    container_name: synclounge
    environment:
      - TZ=Europe/London
      - EXTERNAL_URL=your.domain.com
      - EXTERNAL_SERVER_PORT=80 #optional
      - AUTH_LIST=plexuser1,plexuser2,email1,machineid1 #optional
      - AUTOJOIN_ENABLED=false #optional
      - AUTOJOIN_ROOM=roomname #optional
      - AUTOJOIN_PASSWORD=password #optional
    ports:
      - 8088:8088
      - 8089:8089
    restart: unless-stopped

Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Parameter	Function
-p 8088	Web app port
-p 8089	Server port
-e TZ=Europe/London	Specify a timezone to use EG Europe/London
-e EXTERNAL_URL=your.domain.com	The webapp and the server will be accessible at this address via reverse proxy (alternatively, you can define an external IP address).
-e EXTERNAL_SERVER_PORT=80	If you're not using a reverse proxy, you can define the external port for the server here.
-e AUTH_LIST=plexuser1,plexuser2,email1,machineid1	If set, only the users defined here and the users of the plex servers defined here will be able to access the server. Use e-mails, plex usernames and/or plex server machine ids, comma separated, no spaces.
-e AUTOJOIN_ENABLED=false	Set to true to let users autojoin the server and a room (specified by the AUTOJOIN_ROOM var).
-e AUTOJOIN_ROOM=roomname	Set the room name for auto joining (requires AUTOJOIN_ENABLED set to true).
-e AUTOJOIN_PASSWORD=password	Set the password for the room for auto joining (requires AUTOJOIN_ENABLED set to true).

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

 

Application Setup

The web app is accessible at http://SERVERIP:8088. The server by default is available at http://SERVERIP:EXTERNAL_SERVER_PORT/slserver.

Note: The server address is hardcoded to http as https is not recommended due to not working with external plex clients. When you reverse proxy, use http as the external proto for both webapp and server.

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.

Support Info

• Shell access whilst the container is running: docker exec -it synclounge /bin/bash
• To monitor the logs of the container in realtime: docker logs -f synclounge
• container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' synclounge
• image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/synclounge

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Run/Create

• Update the image: docker pull linuxserver/synclounge
• Stop the running container: docker stop synclounge
• Delete the container: docker rm synclounge
• Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• Start the new container: docker start synclounge
• You can also remove the old dangling images: docker image prune

Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull synclounge
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d synclounge
• You can also remove the old dangling images: docker image prune

Via Watchtower auto-updater (especially useful if you don't remember the original parameters)

• Pull the latest image at its tag and replace it with the same env variables in one run:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once synclounge
  

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

• You can also remove the old dangling images: docker image prune

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-synclounge.git
cd docker-synclounge
docker build \
  --no-cache \
  --pull \
  -t linuxserver/synclounge:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 05.11.20: - Intial Release.