All apps · 0 apps
synclounge
Docker app from linuxserver's Repository
Overview
Readme
View on GitHubThe 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.
- 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
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: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> |
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.
Read-Only Operation
This image can be run with a read-only container filesystem. For details please read the docs.
Non-Root Operation
This image can be run with a non-root user. For details please read the docs.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
[!NOTE] Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.
docker-compose (recommended, click here for more info)
---
services:
synclounge:
image: lscr.io/linuxserver/synclounge:latest
container_name: synclounge
environment:
- AUTH_LIST=plexuser1,plexuser2,email1,machineid1 #optional
ports:
- 8088:8088
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=synclounge \
-e AUTH_LIST=plexuser1,plexuser2,email1,machineid1 `#optional` \
-p 8088:8088 \
--restart unless-stopped \
lscr.io/linuxserver/synclounge:latest
Parameters
Containers 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:8088 |
Web app and server port |
-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. |
--read-only=true |
Run container with a read-only filesystem. Please read the docs. |
--user=1000:1000 |
Run container with a non-root user. Please read the docs. |
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__MYVAR=/run/secrets/mysecretvariable
Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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/bashTo monitor the logs of the container in realtime:
docker logs -f syncloungeContainer version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' syncloungeImage version number:
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/synclounge:latest
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 (noted in the relevant readme.md), 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 Compose
Update images:
All images:
docker-compose pullSingle image:
docker-compose pull synclounge
Update containers:
All containers:
docker-compose up -dSingle container:
docker-compose up -d synclounge
You can also remove the old dangling images:
docker image prune
Via Docker Run
Update the image:
docker pull lscr.io/linuxserver/synclounge:latestStop the running container:
docker stop syncloungeDelete the container:
docker rm syncloungeRecreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved)You can also remove the old dangling images:
docker image prune
Image Update Notifications - Diun (Docker Image Update Notifier)
[!TIP] We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
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 lscr.io/linuxserver/synclounge:latest .
The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
- 15.07.26: - Rebase to Alpine 3.24.
- 19.12.24: - Add support for read-only and non-root operation.
- 05.12.24: - Rebase to Alpine 3.21.
- 04.06.24: - Rebase to Alpine 3.20.
- 26.08.23: - Rebase to Alpine 3.19. Remove deprecated
AUTOJOIN_ENABLED&AUTOJOIN_ROOMoptions. - 26.08.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 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.
Install Synclounge on Unraid in a few clicks.
Find Synclounge in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allDetails
lscr.io/linuxserver/syncloungeRuntime arguments
- Web UI
http://[IP]:[PORT:8088]/- Network
bridge- Shell
bash- Privileged
- false
Template configuration
Web app and server port
- Target
- 8088
- Default
- 8088
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.
- Default
- plexuser1,plexuser2,email1,machineid1
Container Variable: PUID
- Default
- 99
Container Variable: PGID
- Default
- 100
Container Variable: UMASK
- Default
- 022

