Headphones
Container
Headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.
Image details
Configuration
TypeContainerlinuxlinuxserver/headphones:latest8181:8181/tcp/config : /portainer/Files/AppData/Config/Headphones/Downloads : /portainer/Downloads/music : /portainer/MusicPUID=1000PGID=100unless-stoppedTemplate by Qballjos
Standalone Install
Select an install method, to see config/commands for deploying Headphones
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Headphones, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation.

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:
| Architecture | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-\ |
| arm64 | ✅ | arm64v8-\ |
| armhf | ❌ |
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-stoppeddocker 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:latestParameters
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.| Parameter | Function |
|---|---|
-p 8181 | Application WebUI |
-e PUID=1000 | for UserID - see below for explanation |
-e PGID=1000 | for GroupID - see below for explanation |
-e TZ=Etc/UTC | specify a timezone to use, see this list. |
-v /config | Configuration files. |
-v /downloads | ISOs. |
-v /music | Your music directory. |
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prependFILE__.As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariableWill 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_userExample 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:
```bash
docker exec -it headphones /bin/bash
```- To monitor the logs of the container in realtime:
```bash
docker logs -f headphones
```- Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones
```- Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/headphones:latest
```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:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull headphones
```- Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d headphones
```- You can also remove the old dangling images:
```bash
docker image prune
```Via Docker Run
- Update the image:
```bash
docker pull lscr.io/linuxserver/headphones:latest
```- Stop the running container:
```bash
docker stop headphones
```- Delete the container:
```bash
docker rm headphones
```- Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved) - You can also remove the old dangling images:
```bash
docker image prune
```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:
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once headphones
```- 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 x8664 hardware using
multiarch/qemu-user-staticdocker run --rm --privileged multiarch/qemu-user-static:register --resetOnce 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 cpucore 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
Serve Headphones on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying headphones.example.com to http://headphones:8181
Add this to your Caddyfile
headphones.example.com {
reverse_proxy http://headphones:8181
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs headphones - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:8181 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :8181 - Stop the other service, or pick a different host port. In
8181:8181only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:8181. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, headphones can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 8181
Permission denied on volumes
If the logs show "permission denied", the app can't write to its data folder on the host.
- Fix the ownership:
sudo chown -R 1000:100 /portainer/Files/AppData/Config/Headphones(and the same for the other mapped folders) - Or set the
PUIDandPGIDvariables (defaults 1000:100) to match your own user, found withid $USER
Image won't pull
Test the pull directly on the host: docker pull linuxserver/headphones:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm/v7 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect headphones --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue within headphones's repo
- Template not working: Open an issue on Qballjos/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Headphones runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Headphones needs bundled into one download. This template pulls linuxserver/headphones:latest, which Docker fetches once (about 67 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Headphones's comes from Docker Hub, published by linuxserver.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 8181:8181 means it's reachable on port 8181 of your server, where the left number is yours to change and the right one belongs to the app. It opens:
8181:8181
Volumes
A volume is where Headphones keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/configfrom/portainer/Files/AppData/Config/Headphoneson the host/Downloadsfrom/portainer/Downloadson the host/musicfrom/portainer/Musicon the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Headphones takes 2 of them, all with defaults you can leave alone or tweak:
PUID, defaults to1000PGID, defaults to100
Restart policy
The restart policy here is unless-stopped, so Docker restarts Headphones after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Users and permissions
The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.
Networking
Nothing custom is set, so Headphones sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container headphones. That's what you'll spot in the containers list and use in commands like docker logs headphones.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Headphones up. Add the template list to Portainer once, then deploying Headphones is a click rather than a wall of config.