kopia lustrzana https://github.com/linuxserver/docker-documentation
146 wiersze
8.7 KiB
Markdown
146 wiersze
8.7 KiB
Markdown
# [linuxserver/synclounge](https://github.com/linuxserver/docker-synclounge)
|
|
|
|
[](https://github.com/linuxserver/docker-synclounge)
|
|
[](https://github.com/linuxserver/docker-synclounge/releases)
|
|
[](https://github.com/linuxserver/docker-synclounge/packages)
|
|
[](https://gitlab.com/Linuxserver.io/docker-synclounge/container_registry)
|
|
[](https://microbadger.com/images/linuxserver/synclounge "Get your own version badge on microbadger.com")
|
|
[](https://hub.docker.com/r/linuxserver/synclounge)
|
|
[](https://hub.docker.com/r/linuxserver/synclounge)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-synclounge/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/synclounge/latest/index.html)
|
|
|
|
[Synclounge](https://github.com/samcm/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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `ghcr.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 |
|
|
|
|
|
|
## Usage
|
|
|
|
Here are some example snippets to help you get started creating a container from this image.
|
|
|
|
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
Compatible with docker-compose v2 schemas.
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
synclounge:
|
|
image: ghcr.io/linuxserver/synclounge
|
|
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 cli
|
|
|
|
```
|
|
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 \
|
|
ghcr.io/linuxserver/synclounge
|
|
```
|
|
|
|
|
|
## 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 |
|
|
| :----: | --- |
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
## 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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
|
|
|
|
|
## 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.
|
|
|
|
|
|
## Docker Mods
|
|
[](https://mods.linuxserver.io/?mod=synclounge "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/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" }}' ghcr.io/linuxserver/synclounge`
|
|
|
|
## Versions
|
|
|
|
* **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](https://github.com/linuxserver/reverse-proxy-confs/blob/master/synclounge.subdomain.conf.sample) and [here](https://github.com/linuxserver/reverse-proxy-confs/blob/master/synclounge.subfolder.conf.sample)) 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.
|