diff --git a/GENERATED-GITBOOK.md b/GENERATED-GITBOOK.md new file mode 100644 index 0000000..189bc0f --- /dev/null +++ b/GENERATED-GITBOOK.md @@ -0,0 +1,146 @@ +# [linuxserver/headphones](https://github.com/linuxserver/docker-headphones) + +[![](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) + +[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. + +## 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). + +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 | + + +## Usage + +Here are some example snippets to help you get started creating a container from this image. + +### docker + +``` +docker create \ + --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 + +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 | + + +### Environment Variables (`-e`) + +| 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. | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Configuration files. | +| `/downloads` | ISOs. | +| `/music` | Your music directory. | + + + +## 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 username + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + + + +## Support Info + +* 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 diff --git a/GENERATED.md b/GENERATED.md new file mode 100644 index 0000000..71e93d0 --- /dev/null +++ b/GENERATED.md @@ -0,0 +1,173 @@ +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) + +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :- + + * regular and timely application updates + * easy user mappings (PGID, PUID) + * custom base image with s6 overlay + * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth + * regular security updates + +Find us at: +* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. +* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord. +* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! +* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018). + +# PSA: Changes are happening + +From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag. + +TLDR: Multi-arch support is changing from multiple repos to one repo per container image. + +# [linuxserver/headphones](https://github.com/linuxserver/docker-headphones) +[![](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) + +[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. + +[![headphones](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/headphones-banner.png)](https://github.com/rembo10/headphones) + +## 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). + +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 | + + +## Usage + +Here are some example snippets to help you get started creating a container. + +### docker + +``` +docker create \ + --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. + +``` +--- +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 + +Container 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. + +| Parameter | Function | +| :----: | --- | +| `-p 8181` | Application WebUI | +| `-e PUID=1001` | for UserID - see below for explanation | +| `-e PGID=1001` | for GroupID - see below for explanation | +| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. | +| `-v /config` | Configuration files. | +| `-v /downloads` | ISOs. | +| `-v /music` | Your music directory. | + +## 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 username + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + + +  + + +## Support Info + +* 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` + +## Updating Info + +Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. + +Below are the instructions for updating containers: + +### Via Docker Run/Create +* Update the image: `docker pull linuxserver/headphones` +* Stop the running container: `docker stop headphones` +* Delete the container: `docker rm headphones` +* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) +* Start the new container: `docker start headphones` +* You can also remove the old dangling images: `docker image prune` + +### Via Docker Compose +* Update the image: `docker-compose pull linuxserver/headphones` +* Let compose update containers as necessary: `docker-compose up -d` +* You can also remove the old dangling images: `docker image prune` + +## 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 diff --git a/readme-vars.yml b/readme-vars.yml index 83853ea..55aba98 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -2,104 +2,96 @@ # project information project_name: headphones -full_custom_readme: | - {% raw -%} - [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/ +project_url: "https://github.com/rembo10/headphones" +project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/headphones-banner.png" +project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole." +project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" - [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +project_blurb_optional_extras_enabled: false +project_blurb_optional_extras: [] - 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! +# supported architectures +available_architectures: + - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} + - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} + - { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"} - # 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/) - - [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. - - [![headphones](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/headphones-banner.png)][appurl] - - ## Usage - - ``` - 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 - ``` - - ## 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.` +# development version +development_versions: false +development_versions_items: + - { tag: "latest", desc: "Stable Ombi releases" } + - { tag: "development", desc: "Releases from the `develop` branch of Ombi" } - * `-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 +# container parameters +common_param_env_vars_enabled: true #PGID, PUID, etc, you can set it to 'optional' +param_container_name: "{{ project_name }}" +param_usage_include_net: false #you can set it to 'optional' +param_net: "host" +param_net_desc: "Shares host networking with container." +param_usage_include_env: true +param_env_vars: + - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "Configuration files." } + - { vol_path: "/downloads", vol_host_path: "", desc: "ISOs." } + - { vol_path: "/music", vol_host_path: "", desc: "Your music directory." } +param_usage_include_ports: true +param_ports: + - { external_port: "8181", internal_port: "8181", port_desc: "Application WebUI" } +param_device_map: false +param_devices: + - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" } +cap_add_param: false +cap_add_param_vars: + - { cap_add_var: "NET_ADMIN" } - It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it headphones /bin/bash`. +# optional container parameters +opt_param_usage_include_env: false +opt_param_env_vars: + - { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." } +opt_param_usage_include_vols: false +opt_param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "Configuration files." } +opt_param_usage_include_ports: false +opt_param_ports: + - { external_port: "80", internal_port: "80", port_desc: "Application WebUI" } +opt_param_device_map: false +opt_param_devices: + - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" } +opt_cap_add_param: false +opt_cap_add_param_vars: + - { cap_add_var: "NET_ADMIN" } - ### User / Group Identifiers +optional_block_1: false +optional_block_1_items: + - "```" + - "include optional stuff" + - "```" - 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" ™. +# application setup block +app_setup_block_enabled: false +app_setup_block: "" - In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: +app_setup_nginx_reverse_proxy_snippet: true +app_setup_nginx_reverse_proxy_block: "Access WebUI at `:8181` and walk through the wizard." +# changelog - ``` - $ id - uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) - ``` - - ## Setting up the application - - Access WebUI at `:8181` and walk through the wizard. - - ## 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` - - ## 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 - {%- endraw %} +changelogs: + - { date: "16.01.19:", desc: "Add pipeline logic and multi arch." } + - { date: "18.08.18:", desc: "Rebase to alpine 3.8." } + - { date: "03.04.18:", desc: "Remove forced port and update README." } + - { date: "05.01.18:", desc: "Deprecate cpu_core routine lack of scaling." } + - { date: "12.12.17:", desc: "Rebase to alpine 3.7." } + - { date: "20.07.17:", desc: "Internal git pull instead of at runtime." } + - { date: "12.07.17:", desc: "Add inspect commands to README, move to jenkins build and push." } + - { date: "28.05.17:", desc: "Add flac package to handle FLAC based .cue." } + - { date: "25.05.17:", desc: "Rebase to alpine 3.6." } + - { date: "03.05.17:", desc: "Reduce layer, replace broken source for shntool." } + - { date: "07.02.17:", desc: "Rebase to alpine 3.5." } + - { date: "23.12.16:", desc: "Fix capitalisation in README." } + - { date: "09.09.16:", desc: "Add layer badges to README." } + - { date: "27.08.16:", desc: "Add badges to README, compile shntool." } + - { date: "08.08.16:", desc: "Rebase to alpine linux." } + - { date: "18.07.15:", desc: "Inital Release" } \ No newline at end of file