Portainer Templates logo

Portainer Templates

Synclounge Synclounge

Container

Media Tools

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

Image details

Pulls: 4.0M
Architecture: amd64, arm64
Image size: 51 MB
Latest: 5.2.35
User: linuxserver
Created: May 11, 2020
Updated: 4 days ago
Status: active

Source details

Repo: samcm/synclounge
Stars: 1k
Forks: 89
Language: JavaScript
License: MIT
Latest: v5.2.35 · 1 years ago
Updated: 5 days ago

Configuration

Type
Container
Platform
linux
Image
linuxserver/synclounge:latest
Ports
8088:8088/tcp
Volumes
/config : /srv/lsio/synclounge/config
Env vars
AUTH_LIST=plexuser1,plexuser2,email1,machineid1
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/synclounge/config

Standalone Install

Select an install method, to see config/commands for deploying Synclounge

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Synclounge, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see samcm/synclounge for app-specific guidance.

linuxserver.io
Blog Discord Discourse GitHub Open Collective
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.
  • 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

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
Synclounge is a third party tool that allows you to watch Plex in sync with your friends/family, wherever you are.
synclounge

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:
ArchitectureAvailableTag
x86-64✅amd64-\
arm64✅arm64v8-\

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.
ParameterFunction
-p 8088:8088Web app and server port
-e AUTHLIST=plexuser1,plexuser2,email1,machineid1If 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=trueRun container with a read-only filesystem. Please read the docs.
--user=1000:1000Run 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

Docker Mods Docker Universal 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:
```bash
docker exec -it synclounge /bin/bash
```
  • To monitor the logs of the container in realtime:
```bash
docker logs -f synclounge
```
  • Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' synclounge
```
  • Image version number:
```bash
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:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull synclounge
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d synclounge
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/synclounge:latest
```
  • Stop the running container:
```bash
docker stop synclounge
```
  • Delete the container:
```bash
docker rm synclounge
```
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images:
```bash
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 x8664 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_ROOM options.
  • 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_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.

Serve Synclounge on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying synclounge.example.com to http://Synclounge:8088

Add this to your Caddyfile

synclounge.example.com {
	reverse_proxy http://Synclounge:8088
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Synclounge
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8088 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8088
  • Stop the other service, or pick a different host port. In 8088:8088 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8088. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Synclounge can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8088

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/synclounge/config

Image won't pull

Test the pull directly on the host: docker pull linuxserver/synclounge:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Synclounge --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Synclounge runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Synclounge needs bundled into one download. This template pulls linuxserver/synclounge:latest, which Docker fetches once (about 51 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Synclounge's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 5.2.35. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8088:8088 means it's reachable on port 8088 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8088:8088

Volumes

A volume is where Synclounge keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /srv/lsio/synclounge/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Synclounge takes 1 of them, all with defaults you can leave alone or tweak:

  • AUTH_LIST, defaults to 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. [OPTIONAL]

Restart policy

The restart policy here is unless-stopped, so Docker restarts Synclounge after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Synclounge sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Synclounge. That's what you'll spot in the containers list and use in commands like docker logs Synclounge.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Synclounge is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Synclounge up. Add the template list to Portainer once, then deploying Synclounge is a click rather than a wall of config.