docker-headphones/README.md

2.4 KiB
Executable file

https://linuxserver.io

The LinuxServer.io team brings you another container release featuring easy user mapping and community support. Find us for support at:

  • forum.linuxserver.io
  • IRC on freenode at #linuxserver.io
  • Podcast covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!

linuxserver/Headphones

https://github.com/rembo10/headphones

Headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.

Usage

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

Parameters

  • -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

It is based on alpine linux with s6 overlay, for shell access whilst the container is running do docker exec -it Headphones /bin/bash.

User / Group Identifiers

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" ™.

In this instance PUID=1001 and PGID=1001. To find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

Setting up the application

Access WebUI at http://localhost:8181 and walk through the wizard.

Info

  • To monitor the logs of the container in realtime docker logs -f Headphones.

Version History

  • 08.08.16: Rebase to alpine linux.
  • 18.07.15: Inital Release