kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
dfa919deea
commit
bbf9901100
|
|
@ -1,6 +1,14 @@
|
|||
# linuxserver/synclounge
|
||||
# [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) [](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://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/synclounge/latest/index.html)
|
||||
[](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://lsio-ci.ams3.digitaloceanspaces.com/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.
|
||||
|
||||
|
|
@ -13,18 +21,19 @@ Simply pulling `linuxserver/synclounge` should retrieve the correct image for yo
|
|||
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
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=synclounge \
|
||||
-e TZ=Europe/London \
|
||||
|
|
@ -40,6 +49,7 @@ docker create \
|
|||
linuxserver/synclounge
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -67,40 +77,42 @@ services:
|
|||
|
||||
## 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.
|
||||
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`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `8088` | Web app port |
|
||||
| `8089` | Server port |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
| `EXTERNAL_URL=your.domain.com` | The webapp and the server will be accessible at this address via reverse proxy \(alternatively, you can define an external IP address\). |
|
||||
| `EXTERNAL_URL=your.domain.com` | The webapp and the server will be accessible at this address via reverse proxy (alternatively, you can define an external IP address). |
|
||||
| `EXTERNAL_SERVER_PORT=80` | If you're not using a reverse proxy, you can define the external port for the server here. |
|
||||
| `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` | Set to `true` to let users autojoin the server and a room \(specified by the `AUTOJOIN_ROOM` var\). |
|
||||
| `AUTOJOIN_ROOM=roomname` | Set the room name for auto joining \(requires `AUTOJOIN_ENABLED` set to `true`\). |
|
||||
| `AUTOJOIN_PASSWORD=password` | Set the password for the room for auto joining \(requires `AUTOJOIN_ENABLED` set to `true`\). |
|
||||
| `AUTOJOIN_ENABLED=false` | Set to `true` to let users autojoin the server and a room (specified by the `AUTOJOIN_ROOM` var). |
|
||||
| `AUTOJOIN_ROOM=roomname` | Set the room name for auto joining (requires `AUTOJOIN_ENABLED` set to `true`). |
|
||||
| `AUTOJOIN_PASSWORD=password` | Set the password for the room for auto joining (requires `AUTOJOIN_ENABLED` set to `true`). |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -108,7 +120,9 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## 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.
|
||||
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
|
||||
|
||||
|
|
@ -116,11 +130,12 @@ The web app is accessible at `http://SERVERIP:8088`. The server by default is av
|
|||
|
||||
Note: The server address is hardcoded to `http` as `https` is not recommended due to not working with external plex clients. When you reverse proxy, use `http` as the external proto for both webapp and server.
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=synclounge "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=synclounge)
|
||||
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) can be accessed via the dynamic badge above.
|
||||
|
||||
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\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -137,4 +152,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
|
||||
* **01.06.20:** - Rebasing to alpine 3.12.
|
||||
* **05.11.20:** - Intial Release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue