docker-headphones/README.md

204 lines
9 KiB
Markdown
Raw Normal View History

2019-02-11 22:19:01 -05:00
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
2016-09-09 21:37:03 +01:00
2019-02-11 22:19:01 -05:00
* 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
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
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!
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
# [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
2019-02-26 07:56:32 +00:00
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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-11 22:19:01 -05:00
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 | arm32v7-latest |
2015-07-15 11:10:00 -05:00
2016-08-27 23:25:31 +01:00
2015-07-15 11:10:00 -05:00
## Usage
2019-02-11 22:19:01 -05:00
Here are some example snippets to help you get started creating a container.
### docker
2015-07-15 11:10:00 -05:00
```
docker create \
2019-02-11 22:19:01 -05:00
--name=headphones \
2019-03-05 07:56:35 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-11 22:19:01 -05:00
-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
2015-07-15 11:10:00 -05:00
```
2016-10-17 23:52:39 +01:00
2019-02-11 22:19:01 -05:00
### docker-compose
Compatible with docker-compose v2 schemas.
2016-10-17 23:52:39 +01:00
2019-02-11 22:19:01 -05:00
```
---
version: "2"
services:
headphones:
image: linuxserver/headphones
container_name: headphones
environment:
2019-03-05 07:56:35 +00:00
- PUID=1000
- PGID=1000
2019-02-11 22:19:01 -05:00
- TZ=Europe/London
volumes:
- </path/to/appdata/config>:/config
- </path/to/downloads>:/downloads
- </path/to/music>:/music
ports:
- 8181:8181
restart: unless-stopped
```
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
## Parameters
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
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.
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
| Parameter | Function |
| :----: | --- |
| `-p 8181` | Application WebUI |
2019-03-05 07:56:35 +00:00
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
2019-02-11 22:19:01 -05:00
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
| `-v /config` | Configuration files. |
| `-v /downloads` | ISOs. |
| `-v /music` | Your music directory. |
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
## User / Group Identifiers
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
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.
2019-03-05 07:56:35 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```
2019-02-11 22:19:01 -05:00
$ id username
2019-03-05 07:56:35 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
&nbsp;
2015-07-15 11:10:00 -05:00
2019-02-11 22:19:01 -05:00
## Support Info
2019-02-11 22:19:01 -05:00
* 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
2019-02-11 22:19:01 -05:00
* `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
2019-03-05 07:56:35 +00:00
* Update all images: `docker-compose pull`
* or update a single image: `docker-compose pull headphones`
* Let compose update all containers as necessary: `docker-compose up -d`
* or update a single container: `docker-compose up -d headphones`
2019-02-11 22:19:01 -05:00
* You can also remove the old dangling images: `docker image prune`
2019-05-07 06:56:53 +00:00
### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
* Pull the latest image at its tag and replace it with the same env variables in one run:
```
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once headphones
```
2019-07-05 19:11:42 +00:00
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
2019-05-07 06:56:53 +00:00
* You can also remove the old dangling images: `docker image prune`
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```
git clone https://github.com/linuxserver/docker-headphones.git
cd docker-headphones
docker build \
--no-cache \
--pull \
-t linuxserver/headphones:latest .
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
```
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## Versions
2015-07-15 11:10:00 -05:00
2019-07-05 19:11:42 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
* **09.05.19:** - Add default UTC timezone if user does not set it.
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 12:34:41 -05:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-11 22:19:01 -05:00
* **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