From 24ce592fe0e76dfcb95dc119b47b8c14b6f28ae3 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 12 Feb 2019 09:26:44 -0500 Subject: [PATCH] Bot Updating Templated Files --- images/docker-libresonic.md | 184 +++++++++++++++++++++++------------- 1 file changed, 120 insertions(+), 64 deletions(-) diff --git a/images/docker-libresonic.md b/images/docker-libresonic.md index a26616c50..88e8d494a 100755 --- a/images/docker-libresonic.md +++ b/images/docker-libresonic.md @@ -1,100 +1,156 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://github.com/Libresonic/libresonic -[hub]: https://hub.docker.com/r/linuxserver/libresonic/ +# [linuxserver/libresonic](https://github.com/linuxserver/docker-libresonic) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/libresonic.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/libresonic.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-libresonic/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-libresonic/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/libresonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/libresonic/latest/index.html) -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! +[Libresonic](https://github.com/Libresonic/libresonic) is a free, web-based media streamer, providing ubiqutious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. -# linuxserver/libresonic -[![](https://images.microbadger.com/badges/version/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/libresonic.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/libresonic.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-libresonic)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-libresonic/) +## Supported Architectures -[Libresonic][appurl] is a free, web-based media streamer, providing ubiqutious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. +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). + +Simply pulling `linuxserver/libresonic` 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 | arm32v6-latest | -[![libresonic](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/libresonic.png)][appurl] ## Usage +Here are some example snippets to help you get started creating a container from this image. + +### docker + ``` docker create \ ---name="libresonic" \ --v :/config \ --v :/music \ --v :/playlists \ --v :/podcasts \ --v :/media \ --e PGID= -e PUID= \ --e CONTEXT_PATH= \ --e TZ= \ --p 4040:4040 \ -linuxserver/libresonic + --name=libresonic \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -e CONTEXT_PATH= `#optional` \ + -p 4040:4040 \ + -v :/config \ + -v :/music \ + -v :/playlists \ + -v :/podcasts \ + -v :/media `#optional` \ + --restart unless-stopped \ + linuxserver/libresonic +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + libresonic: + image: linuxserver/libresonic + container_name: libresonic + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + - CONTEXT_PATH= #optional + volumes: + - :/config + - :/music + - :/playlists + - :/podcasts + volumes: + - :/media #optional + ports: + - 4040:4040 + mem_limit: 4096m + restart: unless-stopped ``` ## Parameters -`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. -For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. -So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` +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. + +### Ports (`-p`) + +| Parameter | Function | +| :----: | --- | +| `4040` | WebUI | -* `-p 4040` - the port(s) -* `-v /config` - Configuration file location -* `-v /music` - Location of music. -* `-v /playlists` - Location for playlists to be saved to. -* `-v /podcasts` - Location of podcasts. -* `-v /media` - Location of other media - *optional* -* `-e PGID` for for GroupID - see below for explanation - *optional* -* `-e PUID` for for UserID - see below for explanation - *optional* -* `-e CONTEXT_PATH` for setting url-base in reverse proxy setups - *optional* -* `-e TZ` for setting timezone information, eg Europe/London +### Environment Variables (`-e`) -It is based on ubuntu bionic with s6 overlay, for shell access whilst the container is running do `docker exec -it libresonic /bin/bash`. +| Env | Function | +| :----: | --- | +| `PUID=1001` | for UserID - see below for explanation | +| `PGID=1001` | for GroupID - see below for explanation | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | +| `CONTEXT_PATH=` | For setting url-base in reverse proxy setups. | -### User / Group Identifiers +### Volume Mappings (`-v`) -Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™. +| Volume | Function | +| :----: | --- | +| `/config` | Configuration file location. | +| `/music` | Location of music. | +| `/playlists` | Location for playlists to be saved to. | +| `/podcasts` | Location of podcasts. | +| `/media` | Location of other media. | -In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: + + +## User / Group Identifiers + +When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. + +Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. + +In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below: ``` - $ id + $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application +## Application Setup Access WebUI at `:4040`. Default user/pass is admin/admin -## Info -* To monitor the logs of the container in realtime `docker logs -f libresonic`. -* container version number +## Support Info -`docker inspect -f '{{ index .Config.Labels "build_version" }}' libresonic` - -* image version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/libresonic` +* Shell access whilst the container is running: + * `docker exec -it libresonic /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f libresonic` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' libresonic` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/libresonic` ## Versions -+ **15.01.19:** Pull war from github, adding pipeline multi arch builds. -+ **05.01.19:** Linting fixes. -+ **27.08.18:** Rebase to ubuntu bionic. -+ **12.12.17:** Rebase to alpine 3.7. -+ **11.07.17:** Rebase to alpine 3.6. -+ **12.05.17:** Add annotation timeout (primarily for armhf and lower powered hosts). -+ **08.02.17:** Rebase to alpine 3.5. -+ **04.12.16:** Update jetty runner version. -+ **29.11.16:** Switch to building from release tags following v6.1 stable release. -+ **17.11.16:** Initial Release. +* **15.01.19:** - Pull war from github, adding pipeline multi arch builds. +* **05.01.19:** - Linting fixes. +* **27.08.18:** - Rebase to ubuntu bionic. +* **12.12.17:** - Rebase to alpine 3.7. +* **11.07.17:** - Rebase to alpine 3.6. +* **12.05.17:** - Add annotation timeout (primarily for armhf and lower powered hosts). +* **08.02.17:** - Rebase to alpine 3.5. +* **04.12.16:** - Update jetty runner version. +* **29.11.16:** - Switch to building from release tags following v6.1 stable release. +* **17.11.16:** - Initial Release.