Bot Updating Templated Files

pull/9/head
LinuxServer-CI 2019-10-01 02:57:41 -04:00
rodzic 44c59bad74
commit bb370f0f15
1 zmienionych plików z 27 dodań i 15 usunięć

Wyświetl plik

@ -1,6 +1,12 @@
# linuxserver/headphones
# [linuxserver/headphones](https://github.com/linuxserver/docker-headphones)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-headphones.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-headphones/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/headphones.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/headphones) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/headphones.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/headphones) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/headphones.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/headphones) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/headphones.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/headphones) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-headphones/job/master/badge/icon?style=flat-square)](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)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-headphones.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-headphones/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/headphones.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/headphones.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/headphones)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/headphones.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/headphones)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-headphones/job/master/badge/icon?style=flat-square)](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.
@ -13,18 +19,19 @@ Simply pulling `linuxserver/headphones` should retrieve the correct image for yo
The architectures supported by this image are:
| Architecture | Tag |
| :---: | :--- |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
```text
```
docker create \
--name=headphones \
-e PUID=1000 \
@ -38,6 +45,7 @@ docker create \
linuxserver/headphones
```
### docker-compose
Compatible with docker-compose v2 schemas.
@ -64,43 +72,48 @@ services:
## 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.
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`\)
### Ports (`-p`)
| Parameter | Function |
| :---: | :--- |
| :----: | --- |
| `8181` | Application WebUI |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function |
| :---: | :--- |
| :----: | --- |
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### Volume Mappings \(`-v`\)
### Volume Mappings (`-v`)
| Volume | Function |
| :---: | :--- |
| :----: | --- |
| `/config` | Configuration files. |
| `/downloads` | ISOs. |
| `/music` | Your music directory. |
## 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`.
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:
```text
```
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Support Info
* Shell access whilst the container is running:
@ -121,7 +134,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
* **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.
* **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.
@ -134,4 +147,3 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
* **27.08.16:** - Add badges to README, compile shntool.
* **08.08.16:** - Rebase to alpine linux.
* **18.07.15:** - Inital Release