9.5 KiB
title |
---|
headphones |
linuxserver/headphones
Headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/headphones:latest
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 | Available | Tag |
---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ✅ | arm32v7-<version tag> |
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
---
version: "2.1"
services:
headphones:
image: lscr.io/linuxserver/headphones:latest
container_name: headphones
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/appdata/config:/config
- /path/to/downloads:/downloads
- /path/to/music:/music
ports:
- 8181:8181
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=headphones \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 8181:8181 \
-v /path/to/appdata/config:/config \
-v /path/to/downloads:/downloads \
-v /path/to/music:/music \
--restart unless-stopped \
lscr.io/linuxserver/headphones:latest
Parameters
Docker 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.
Ports (-p
)
Parameter | Function |
---|---|
8181 |
Application WebUI |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Etc/UTC |
specify a timezone to use, see this list. |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Configuration files. |
/downloads |
ISOs. |
/music |
Your music directory. |
Miscellaneous Options
Parameter | Function |
---|
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD
based on the contents of the /run/secrets/mysecretpassword
file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022
setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
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=1000
and PGID=1000
, to find yours use id user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
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" }}' lscr.io/linuxserver/headphones:latest
Versions
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 02.02.22: - Rebasing to alpine 3.15. Updating to Python 3.
- 19.12.19: - Rebasing to alpine 3.11.
- 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.
- 22.02.19: - Rebasing to alpine 3.9.
- 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