From e7b6ffd654f4326877487818cad38ee456ee1690 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 12 Feb 2019 14:46:54 +0000 Subject: [PATCH] Bot Updating Templated Files --- images/docker-headphones.md | 182 +++++++++++++++++++++++------------- 1 file changed, 115 insertions(+), 67 deletions(-) diff --git a/images/docker-headphones.md b/images/docker-headphones.md index 4e101fffb..189bc0fc3 100644 --- a/images/docker-headphones.md +++ b/images/docker-headphones.md @@ -1,98 +1,146 @@ -[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/rembo10/headphones -[hub]: https://hub.docker.com/r/linuxserver/headphones/ +# [linuxserver/headphones](https://github.com/linuxserver/docker-headphones) -[![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/headphones.svg)](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/headphones.svg)](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/headphones.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/headphones.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-headphones/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-headphones/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/headphones/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/headphones/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! +[Headphones](https://github.com/rembo10/headphones) is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole. -# linuxserver/headphones -[![](https://images.microbadger.com/badges/version/linuxserver/headphones.svg)](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/headphones.svg)](https://microbadger.com/images/linuxserver/headphones "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/headphones.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/headphones.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-headphones)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-headphones/) +## Supported Architectures -[headphones](https://hub.docker.com/r/linuxserver/headphones/) is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole. +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/headphones` 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 | -[![headphones](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/headphones-banner.png)][appurl] ## Usage +Here are some example snippets to help you get started creating a container from this image. + +### docker + ``` docker create \ - --name="headphones" \ - -v /path/to/headphones/data:/config \ - -v /path/to/downloads:/downloads \ - -v /path/to/music:/music \ - -e PGID= -e PUID= \ - -e TZ= \ - -p 8181:8181 \ - linuxserver/headphones + --name=headphones \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -p 8181:8181 \ + -v :/config \ + -v :/downloads \ + -v :/music \ + --restart unless-stopped \ + linuxserver/headphones +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + headphones: + image: linuxserver/headphones + container_name: headphones + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + - :/downloads + - :/music + ports: + - 8181:8181 + 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 | +| :----: | --- | +| `8181` | Application WebUI | -* `-p 8181` - the port(s) -* `-v /config` - Configuration file location -* `-v /music` - Location of music. (i.e. /opt/downloads/music or /var/music) -* `-v /downloads` - Location of downloads folder -* `-e PGID` for for GroupID - see below for explanation - *optional* -* `-e PUID` for for UserID - see below for explanation - *optional* -* `-e TZ` for setting timezone information, eg Europe/London +### Environment Variables (`-e`) -It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it headphones /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. | -### 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 files. | +| `/downloads` | ISOs. | +| `/music` | Your music directory. | -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 -Access WebUI at `:8181` and walk through the wizard. -## Info +## Support Info -* To monitor the logs of the container in realtime `docker logs -f headphones`. - -* container version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones` - -* image version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/headphones` +* Shell access whilst the container is running: + * `docker exec -it headphones /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f headphones` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/headphones` ## Versions -+ **16.01.19:** Add pipeline logic and multi arch. -+ **18.08.18:** Rebase to alpine 3.8. -+ **03.04.18:** Remove forced port and update README. -+ **05.01.18:** Deprecate cpu_core routine lack of scaling. -+ **12.12.17:** Rebase to alpine 3.7. -+ **20.07.17:** Internal git pull instead of at runtime. -+ **12.07.17:** Add inspect commands to README, move to jenkins build and push. -+ **28.05.17:** Add flac package to handle FLAC based .cue. -+ **25.05.17:** Rebase to alpine 3.6. -+ **03.05.17:** Reduce layer, replace broken source for shntool. -+ **07.02.17:** Rebase to alpine 3.5. -+ **23.12.16:** Fix capitalisation in README. -+ **09.09.16:** Add layer badges to README. -+ **27.08.16:** Add badges to README, compile shntool. -+ **08.08.16:** Rebase to alpine linux. -+ **18.07.15:** Inital Release +* **16.01.19:** - Add pipeline logic and multi arch. +* **18.08.18:** - Rebase to alpine 3.8. +* **03.04.18:** - Remove forced port and update README. +* **05.01.18:** - Deprecate cpu_core routine lack of scaling. +* **12.12.17:** - Rebase to alpine 3.7. +* **20.07.17:** - Internal git pull instead of at runtime. +* **12.07.17:** - Add inspect commands to README, move to jenkins build and push. +* **28.05.17:** - Add flac package to handle FLAC based .cue. +* **25.05.17:** - Rebase to alpine 3.6. +* **03.05.17:** - Reduce layer, replace broken source for shntool. +* **07.02.17:** - Rebase to alpine 3.5. +* **23.12.16:** - Fix capitalisation in README. +* **09.09.16:** - Add layer badges to README. +* **27.08.16:** - Add badges to README, compile shntool. +* **08.08.16:** - Rebase to alpine linux. +* **18.07.15:** - Inital Release