From 5ecbbb01a2290efd926474cc8e13fbaf90cfa787 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 17 Jul 2020 15:32:53 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-daapd.md | 77 ++++++++++++++++++++++++++++++------------ 1 file changed, 56 insertions(+), 21 deletions(-) diff --git a/images/docker-daapd.md b/images/docker-daapd.md index 7dc50bdfc5..83e9d549a5 100644 --- a/images/docker-daapd.md +++ b/images/docker-daapd.md @@ -1,8 +1,16 @@ -# linuxserver/daapd +# [linuxserver/daapd](https://github.com/linuxserver/docker-daapd) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-daapd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-daapd) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-daapd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-daapd/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-daapd/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-daapd/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/daapd) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/daapd.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/daapd) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/daapd.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/daapd) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/daapd.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/daapd) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-daapd/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-daapd/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/daapd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/daapd/latest/index.html) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-daapd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-daapd) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-daapd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-daapd/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-daapd/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/Linuxserver.io/docker-daapd/container_registry) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/daapd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/daapd "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/daapd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/daapd) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/daapd.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/daapd) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-daapd%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-daapd/job/master/) +[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Fdaapd%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/daapd/latest/index.html) -[Daapd](https://ejurgensen.github.io/forked-daapd/) \(iTunes\) media server with support for AirPlay devices, Apple Remote \(and compatibles\), Chromecast, MPD and internet radio. +[Daapd](https://ejurgensen.github.io/forked-daapd/) (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio. ## Supported Architectures @@ -13,18 +21,19 @@ Simply pulling `linuxserver/daapd` should retrieve the correct image for your ar 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=daapd \ --net=host \ @@ -37,13 +46,14 @@ docker create \ linuxserver/daapd ``` + ### docker-compose Compatible with docker-compose v2 schemas. ```yaml --- -version: "2" +version: "2.1" services: daapd: image: linuxserver/daapd @@ -61,44 +71,62 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :---: | :--- | - - -#### Networking \(`--net`\) +| :----: | --- | +#### Networking (`--net`) | Parameter | Function | -| :---: | :--- | +| :-----: | --- | | `--net=host` | Shares host networking with container. | -### 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` | Where daapd server stores its config and dbase files. | | `/music` | Map to your music folder. | + + +## 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](https://en.wikipedia.org/wiki/Umask) 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`. +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) ``` @@ -111,6 +139,13 @@ The web interface is available at `http://:3689` For further setup options of remotes etc, check out the daapd website, [Forked-daapd](https://ejurgensen.github.io/forked-daapd/). + +## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&query=%24.mods%5B%27daapd%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=daapd "view available mods for this container.") + +We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above. + + ## Support Info * Shell access whilst the container is running: @@ -124,6 +159,7 @@ For further setup options of remotes etc, check out the daapd website, [Forked-d ## Versions +* **01.06.20:** - Rebasing to alpine 3.12. * **16.01.20:** - Rebase to alpine linux 3.11 and build antlr3c from source. * **23.03.19:** - Switching to new Base images, shift to arm32v7 tag. * **14.01.19:** - Add pipeline logic and multi arch. @@ -131,7 +167,7 @@ For further setup options of remotes etc, check out the daapd website, [Forked-d * **09.06.18:** - Use buildstage and update dependencies. * **05.03.18:** - Use updated configure ac and disable avcodecsend to hopefully mitigate crashes with V26. * **25.02.18:** - Query version before pull and build latest release. -* **03.01.18:** - Deprecate cpu\_core routine lack of scaling. +* **03.01.18:** - Deprecate cpu_core routine lack of scaling. * **07.12.17:** - Rebase to alpine linux 3.7. * **03.12.17:** - Bump to 25.0, cpu core counting routine for faster builds, linting fixes. * **26.05.17:** - Rebase to alpine linux 3.6. @@ -143,4 +179,3 @@ For further setup options of remotes etc, check out the daapd website, [Forked-d * **04.01.16:** - Disable ipv6 by default because in v23.4 it doesn't work in unraid with it set. * **17.12.15:** - Add in spotify support. * **25.11.15:** - Initial Release. -