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 lscr.io/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
Application Setup
The web app and the server are both accessible at http://SERVERIP:8088.
Note: It is recommended to use http as the external proto with a reverse proxy due to https not working with external plex clients.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
1
---
2
version: "2.1"
3
services:
4
  synclounge:
5
    image: lscr.io/linuxserver/synclounge
6
    container_name: synclounge
7
    environment:
8
      - TZ=Europe/London
9
      - AUTH_LIST=plexuser1,plexuser2,email1,machineid1 #optional
10
      - AUTOJOIN_ENABLED=false #optional
11
      - AUTOJOIN_ROOM=roomname #optional
12
    ports:
13
      - 8088:8088
14
    restart: unless-stopped
Copied!
docker cli (click here for more info)
1
docker run -d \
2
  --name=synclounge \
3
  -e TZ=Europe/London \
4
  -e AUTH_LIST=plexuser1,plexuser2,email1,machineid1 `#optional` \
5
  -e AUTOJOIN_ENABLED=false `#optional` \
6
  -e AUTOJOIN_ROOM=roomname `#optional` \
7
  -p 8088:8088 \
8
  --restart unless-stopped \
9
  lscr.io/linuxserver/synclounge
Copied!
Parameters
Docker 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.
Ports (-p)
Parameter
Function
8088
Web app and server port
Environment Variables (-e)
Env
Function
TZ=Europe/London
Specify a timezone to use EG Europe/London
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.
AUTOJOIN_ENABLED=false
DEPRECATED - (Still works but will be removed in the future in favor of the built-in var autojoin__room) - Set to true to let users autojoin the server and a room (specified by the AUTOJOIN_ROOM var).
AUTOJOIN_ROOM=roomname
DEPRECATED - (Still works but will be removed in the future in favor of the built-in var autojoin__room) - Set the room name for auto joining (requires AUTOJOIN_ENABLED set to true).
Volume Mappings (-v)
Volume
Function
Miscellaneous Options
Parameter
Function
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
Docker Mods
​​
​ ​
​​
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges 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" }}' lscr.io/linuxserver/synclounge
Versions
12.02.21: - Fix optional dependency builds in aarch64 image.
12.02.21: - Rebasing to alpine 3.13.
28.10.20: - Update to v4. Env vars EXTERNAL_URL, EXTERNAL_SERVER_PORT and AUTOJOIN_PASSWORD are deprecated and no longer have any effect. Env vars AUTOJOIN_ENABLED and AUTOJOIN_ROOM are still working but will be removed in the future in favor of synclounge's built-in var autojoin__room. If you are reverse proxying, do not forget to update your proxy settings (here and here) as the server port and addresses are changed.
11.10.20: - Pin builds to upstream commit 6aecc9bd while evaluating the breaking changes upstream.
27.09.20: - Updating the external repo endpoint.
01.06.20: - Rebasing to alpine 3.12.
11.05.20: - Initial Release.