linuxserver/synclounge
Synclounge is a third party tool that allows you to watch Plex in sync with your friends/family, wherever you are.
Simply pulling
lscr.io/linuxserver/synclounge:latest 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 | Available | Tag |
|---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ✅ | arm32v7-<version tag> |
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.To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
synclounge:
image: lscr.io/linuxserver/synclounge:latest
container_name: synclounge
environment:
- TZ=Europe/London
- AUTH_LIST=plexuser1,plexuser2,email1,machineid1 #optional
- AUTOJOIN_ENABLED=false #optional
- AUTOJOIN_ROOM=roomname #optional
ports:
- 8088:8088
restart: unless-stopped
docker run -d \
--name=synclounge \
-e TZ=Europe/London \
-e AUTH_LIST=plexuser1,plexuser2,email1,machineid1 `#optional` \
-e AUTOJOIN_ENABLED=false `#optional` \
-e AUTOJOIN_ROOM=roomname `#optional` \
-p 8088:8088 \
--restart unless-stopped \
lscr.io/linuxserver/synclounge:latest
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.Parameter | Function |
|---|---|
8088 | Web app and server port |
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). |
Miscellaneous Options
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.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.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.
- 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:latest
- 29.11.22: - Rebase to alpine 3.17, upgrade to s6v3.
- 19.09.22: - Rebase to alpine 3.15.
- 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_PORTandAUTOJOIN_PASSWORDare deprecated and no longer have any effect. Env varsAUTOJOIN_ENABLEDandAUTOJOIN_ROOMare still working but will be removed in the future in favor of synclounge's built-in varautojoin__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
6aecc9bdwhile 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.
Last modified 4d ago