linuxserver/headphones repository overview

The 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:

• Blog⁠ - all the things you can do with our containers including How-To guides, opinions and much more!
• Discord⁠ - realtime support / chat with the community and the team.
• Discourse⁠ - post on our community forum.
• Fleet⁠ - an online web interface which displays all of our maintained images.
• GitHub⁠ - view the source for all of our repositories.
• Open Collective⁠ - please consider helping us by either donating or contributing to our budget

⁠This image is deprecated. We will not offer support for this image and it will not be updated.

⁠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:

⁠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

Containers 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.

⁠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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

⁠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
  

  Copy

• To monitor the logs of the container in realtime:

  docker logs -f headphones
  

  Copy

• Container version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones
  

  Copy

• Image version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/headphones:latest
  

  Copy

⁠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⁠ section above to see if it is recommended for the image.

Below are the instructions for updating containers:

⁠Via Docker Compose

• Update images:

  • All images:

    docker-compose pull
    

    Copy

  • Single image:

    docker-compose pull headphones
    

    Copy

• Update containers:

  • All containers:

    docker-compose up -d
    

    Copy

  • Single container:

    docker-compose up -d headphones
    

    Copy

• You can also remove the old dangling images:

  docker image prune
  

  Copy

⁠Via Docker Run

• Update the image:

  docker pull lscr.io/linuxserver/headphones:latest
  

  Copy

• Stop the running container:

  docker stop headphones
  

  Copy

• Delete the container:

  docker rm headphones
  

  Copy

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  docker image prune
  

  Copy

⁠Via Watchtower auto-updater (only use 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
  

  Copy

• You can also remove the old dangling images: docker image prune

warning: 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⁠.

⁠Image Update Notifications - Diun (Docker Image Update Notifier)

tip: We recommend Diun⁠ for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

⁠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 lscr.io/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

• 17.10.23: - Deprecate image.
• 06.07.23: - Deprecate armhf. As announced here⁠
• 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