From 1cdd48760b98af8fefa24ed0d6fe16a71ab07bf9 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 21 Apr 2021 05:42:15 +0100 Subject: [PATCH] Bot Updating Documentation --- images/docker-synclounge.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/images/docker-synclounge.md b/images/docker-synclounge.md index 8e31cf0e8d..bbdedf9583 100644 --- a/images/docker-synclounge.md +++ b/images/docker-synclounge.md @@ -1,6 +1,9 @@ --- title: synclounge --- + + + # [linuxserver/synclounge](https://github.com/linuxserver/docker-synclounge) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-synclounge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-synclounge) @@ -29,6 +32,11 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## 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. ## Usage @@ -57,7 +65,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=synclounge \ -e TZ=Europe/London \ @@ -69,7 +77,6 @@ docker run -d \ 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 `:` 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. @@ -80,7 +87,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8088` | Web app and server port | - ### Environment Variables (`-e`) | Env | Function | @@ -95,15 +101,13 @@ Docker images are configured using parameters passed at runtime (such as those a | 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: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -114,20 +118,12 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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 + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=synclounge&query=%24.mods%5B%27synclounge%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=synclounge "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](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: