This repository has been archived by the owner on Nov 12, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #40 from IronicBadger/master
dynamic readme
- Loading branch information
Showing
2 changed files
with
234 additions
and
167 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,173 @@ | ||
| [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/ | ||
| [](https://linuxserver.io) | ||
|
|
||
| [][linuxserverurl] | ||
| The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :- | ||
|
|
||
| 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! | ||
| * 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 | ||
|
|
||
| # linuxserver/headphones | ||
| [](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/headphones "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-headphones/) | ||
| 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). | ||
|
|
||
| [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. | ||
| # 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://discord.gg/YWrKVTn) | ||
| [](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com") | ||
| [](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com") | ||
|  | ||
|  | ||
| [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-headphones/job/master/) | ||
| [](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. | ||
|
|
||
| [](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 | | ||
|
|
||
| [][appurl] | ||
|
|
||
| ## Usage | ||
|
|
||
| Here are some example snippets to help you get started creating a container. | ||
|
|
||
| ### docker | ||
|
|
||
| ``` | ||
| docker create \ | ||
| --name="headphones" \ | ||
| -v /path/to/headphones/data:/config \ | ||
| -v /path/to/downloads:/downloads \ | ||
| -v /path/to/music:/music \ | ||
| -e PGID=<gid> -e PUID=<uid> \ | ||
| -e TZ=<timezone> \ | ||
| -p 8181:8181 \ | ||
| linuxserver/headphones | ||
| --name=headphones \ | ||
| -e PUID=1001 \ | ||
| -e PGID=1001 \ | ||
| -e TZ=Europe/London \ | ||
| -p 8181:8181 \ | ||
| -v </path/to/appdata/config>:/config \ | ||
| -v </path/to/downloads>:/downloads \ | ||
| -v </path/to/music>:/music \ | ||
| --restart unless-stopped \ | ||
| 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.` | ||
| ### 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: | ||
| - </path/to/appdata/config>:/config | ||
| - </path/to/downloads>:/downloads | ||
| - </path/to/music>:/music | ||
| ports: | ||
| - 8181:8181 | ||
| mem_limit: 4096m | ||
| restart: unless-stopped | ||
| ``` | ||
|
|
||
| * `-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 | ||
| ## Parameters | ||
|
|
||
| It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it headphones /bin/bash`. | ||
| Container 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. | ||
|
|
||
| ### User / Group Identifiers | ||
| | 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. | | ||
|
|
||
| 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" ™. | ||
| ## User / Group Identifiers | ||
|
|
||
| In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: | ||
| 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 <dockeruser> | ||
| $ id username | ||
| uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) | ||
| ``` | ||
|
|
||
| ## Setting up the application | ||
|
|
||
| Access WebUI at `<your-ip>: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` | ||
| ## 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` | ||
| * `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 | ||
| * **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 |
Oops, something went wrong.