mirror of
https://github.com/linuxserver/docker-daapd.git
synced 2026-02-07 03:48:35 +08:00
adding dynamic readme
This commit is contained in:
thelamer
parent
a4c0e691f5
commit
ef02db09be
204
README.md
204
README.md
@ -1,100 +1,178 @@
|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://ejurgensen.github.io/forked-daapd/
|
||||
[hub]: https://hub.docker.com/r/linuxserver/daapd/
|
||||
[](https://linuxserver.io)
|
||||
|
||||
[][linuxserverurl]
|
||||
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
|
||||
|
||||
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
||||
* [forum.linuxserver.io][forumurl]
|
||||
* [IRC][ircurl] on freenode at `#linuxserver.io`
|
||||
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
||||
* 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
|
||||
|
||||
# linuxserver/daapd
|
||||
[](https://microbadger.com/images/linuxserver/daapd "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/daapd "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-daapd/)
|
||||
Find us at:
|
||||
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
|
||||
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
|
||||
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
||||
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
|
||||
|
||||
[Forked-Daapd][appurl] (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio.
|
||||
# PSA: Changes are happening
|
||||
|
||||
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
|
||||
|
||||
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
|
||||
|
||||
# [linuxserver/daapd](https://github.com/linuxserver/docker-daapd)
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/daapd "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/daapd "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-daapd/job/master/)
|
||||
[](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.
|
||||
|
||||
[](https://ejurgensen.github.io/forked-daapd/)
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
|
||||
|
||||
Simply pulling `linuxserver/daapd` 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 | Tag |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name=daapd \
|
||||
-v <path to data>:/config \
|
||||
-v <path to music>:/music \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
--net=host \
|
||||
linuxserver/daapd
|
||||
--name=daapd \
|
||||
--net=host \
|
||||
-e PUID=1001 \
|
||||
-e PGID=1001 \
|
||||
-e TZ=Europe/London \
|
||||
-v <path to data>:/config \
|
||||
-v <path to music>:/music \
|
||||
--restart unless-stopped \
|
||||
linuxserver/daapd
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
daapd:
|
||||
image: linuxserver/daapd
|
||||
container_name: daapd
|
||||
network_mode: host
|
||||
environment:
|
||||
- PUID=1001
|
||||
- PGID=1001
|
||||
- TZ=Europe/London
|
||||
volumes:
|
||||
- <path to data>:/config
|
||||
- <path to music>:/music
|
||||
mem_limit: 4096m
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
||||
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
|
||||
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
|
||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
|
||||
Container 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.
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| `--net=host` | Shares host networking with container. |
|
||||
| `-e PUID=1001` | for UserID - see below for explanation |
|
||||
| `-e PGID=1001` | for GroupID - see below for explanation |
|
||||
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `-v /config` | Where daapd server stores its config and dbase files. |
|
||||
| `-v /music` | Map to your music folder. |
|
||||
|
||||
* `--net=host` - must be run in host mode
|
||||
* `-v /config` - Where daapd server stores its config and dbase files.
|
||||
* `-v /music` - map to your music folder
|
||||
* `-e PGID` for GroupID - see below for explanation
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
## User / Group Identifiers
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it daapd /bin/bash`.
|
||||
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`.
|
||||
|
||||
### User / Group Identifiers
|
||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||
|
||||
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:
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
$ id username
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
|
||||
|
||||
## Application Setup
|
||||
|
||||
Map your music folder, open up itunes on the same LAN to see your music there.
|
||||
|
||||
The web interface is available at `http://<your ip>:3689`
|
||||
|
||||
For further setup options of remotes etc, check out the daapd website, [Forked-daapd][appurl].
|
||||
For further setup options of remotes etc, check out the daapd website, [Forked-daapd](https://ejurgensen.github.io/forked-daapd/).
|
||||
|
||||
|
||||
## Logs and shell
|
||||
* To monitor the logs of the container in realtime `docker logs -f daapd`.
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running: `docker exec -it daapd /bin/bash`
|
||||
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' daapd`
|
||||
|
||||
* To monitor the logs of the container in realtime: `docker logs -f daapd`
|
||||
* container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' daapd`
|
||||
* image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/daapd`
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/daapd`
|
||||
## 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](#application-setup) section above to see if it is recommended for the image.
|
||||
|
||||
Below are the instructions for updating containers:
|
||||
|
||||
### Via Docker Run/Create
|
||||
* Update the image: `docker pull linuxserver/daapd`
|
||||
* Stop the running container: `docker stop daapd`
|
||||
* Delete the container: `docker rm daapd`
|
||||
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
||||
* Start the new container: `docker start daapd`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
### Via Docker Compose
|
||||
* Update the image: `docker-compose pull linuxserver/daapd`
|
||||
* Let compose update containers as necessary: `docker-compose up -d`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
## Versions
|
||||
|
||||
+ **14.01.19:** Adding pipeline logic and multi arch.
|
||||
+ **20.08.18:** Rebase to alpine linux 3.8.
|
||||
+ **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.
|
||||
+ **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.
|
||||
+ **06.02.17:** Rebase to alpine linux 3.5.
|
||||
+ **10.01.17:** Bump to 24.2.
|
||||
+ **14.10.16:** Add version layer information.
|
||||
+ **17.09.16:** Rebase to alpine linux, remove redundant spotify support, move to main repository
|
||||
+ **28.02.16:** Add chromecast support, bump dependency versions.
|
||||
+ **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.
|
||||
* **14.01.19:** - Add pipeline logic and multi arch.
|
||||
* **20.08.18:** - Rebase to alpine linux 3.8.
|
||||
* **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.
|
||||
* **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.
|
||||
* **06.02.17:** - Rebase to alpine linux 3.5.
|
||||
* **10.01.17:** - Bump to 24.2.
|
||||
* **14.10.16:** - Add version layer information.
|
||||
* **17.09.16:** - Rebase to alpine linux, remove redundant spotify support, move to main repository.
|
||||
* **28.02.16:** - Add chromecast support, bump dependency versions.
|
||||
* **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.
|
||||
|
||||
151
readme-vars.yml
151
readme-vars.yml
@ -2,106 +2,71 @@
|
||||
|
||||
# project information
|
||||
project_name: daapd
|
||||
full_custom_readme: |
|
||||
{% raw -%}
|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://ejurgensen.github.io/forked-daapd/
|
||||
[hub]: https://hub.docker.com/r/linuxserver/daapd/
|
||||
project_url: "https://ejurgensen.github.io/forked-daapd/"
|
||||
project_logo: "https://raw.githubusercontent.com/linuxserver/beta-templates/master/lsiodev/img/daapd-git.png"
|
||||
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio."
|
||||
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
|
||||
project_blurb_optional_extras_enabled: false
|
||||
|
||||
[][linuxserverurl]
|
||||
# supported architectures
|
||||
available_architectures:
|
||||
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
|
||||
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
||||
- { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"}
|
||||
|
||||
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
||||
* [forum.linuxserver.io][forumurl]
|
||||
* [IRC][ircurl] on freenode at `#linuxserver.io`
|
||||
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
||||
# development version
|
||||
development_versions: false
|
||||
|
||||
# linuxserver/daapd
|
||||
[](https://microbadger.com/images/linuxserver/daapd "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/daapd "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-daapd/)
|
||||
# container parameters
|
||||
common_param_env_vars_enabled: true
|
||||
param_container_name: "{{ project_name }}"
|
||||
param_usage_include_net: true
|
||||
param_net: "host"
|
||||
param_net_desc: "Shares host networking with container."
|
||||
param_usage_include_env: true
|
||||
param_env_vars:
|
||||
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
|
||||
param_usage_include_vols: true
|
||||
param_volumes:
|
||||
- { vol_path: "/config", vol_host_path: "<path to data>", desc: "Where daapd server stores its config and dbase files." }
|
||||
- { vol_path: "/music", vol_host_path: "<path to music>", desc: "Map to your music folder." }
|
||||
param_usage_include_ports: false
|
||||
param_device_map: false
|
||||
cap_add_param: false
|
||||
|
||||
[Forked-Daapd][appurl] (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio.
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name=daapd \
|
||||
-v <path to data>:/config \
|
||||
-v <path to music>:/music \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
--net=host \
|
||||
linuxserver/daapd
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
||||
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
|
||||
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
|
||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
|
||||
|
||||
|
||||
* `--net=host` - must be run in host mode
|
||||
* `-v /config` - Where daapd server stores its config and dbase files.
|
||||
* `-v /music` - map to your music folder
|
||||
* `-e PGID` for GroupID - see below for explanation
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it daapd /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
|
||||
# optional container parameters
|
||||
opt_param_usage_include_env: false
|
||||
opt_param_usage_include_vols: false
|
||||
opt_param_usage_include_ports: false
|
||||
opt_param_device_map: false
|
||||
opt_cap_add_param: false
|
||||
optional_block_1: false
|
||||
|
||||
# application setup block
|
||||
app_setup_block_enabled: true
|
||||
app_setup_block: |
|
||||
Map your music folder, open up itunes on the same LAN to see your music there.
|
||||
|
||||
The web interface is available at `http://<your ip>:3689`
|
||||
|
||||
For further setup options of remotes etc, check out the daapd website, [Forked-daapd][appurl].
|
||||
For further setup options of remotes etc, check out the daapd website, [Forked-daapd]({{ project_url }}).
|
||||
|
||||
|
||||
## Logs and shell
|
||||
* To monitor the logs of the container in realtime `docker logs -f daapd`.
|
||||
* Shell access whilst the container is running: `docker exec -it daapd /bin/bash`
|
||||
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' daapd`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/daapd`
|
||||
|
||||
## Versions
|
||||
|
||||
+ **14.01.19:** Adding pipeline logic and multi arch.
|
||||
+ **20.08.18:** Rebase to alpine linux 3.8.
|
||||
+ **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.
|
||||
+ **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.
|
||||
+ **06.02.17:** Rebase to alpine linux 3.5.
|
||||
+ **10.01.17:** Bump to 24.2.
|
||||
+ **14.10.16:** Add version layer information.
|
||||
+ **17.09.16:** Rebase to alpine linux, remove redundant spotify support, move to main repository
|
||||
+ **28.02.16:** Add chromecast support, bump dependency versions.
|
||||
+ **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.
|
||||
{%- endraw %}
|
||||
# changelog
|
||||
changelogs:
|
||||
- { date: "14.01.19:", desc: "Add pipeline logic and multi arch." }
|
||||
- { date: "20.08.18:", desc: "Rebase to alpine linux 3.8." }
|
||||
- { date: "09.06.18:", desc: "Use buildstage and update dependencies." }
|
||||
- { date: "05.03.18:", desc: "Use updated configure ac and disable avcodecsend to hopefully mitigate crashes with V26." }
|
||||
- { date: "25.02.18:", desc: "Query version before pull and build latest release." }
|
||||
- { date: "03.01.18:", desc: "Deprecate cpu_core routine lack of scaling." }
|
||||
- { date: "07.12.17:", desc: "Rebase to alpine linux 3.7." }
|
||||
- { date: "03.12.17:", desc: "Bump to 25.0, cpu core counting routine for faster builds, linting fixes." }
|
||||
- { date: "26.05.17:", desc: "Rebase to alpine linux 3.6." }
|
||||
- { date: "06.02.17:", desc: "Rebase to alpine linux 3.5." }
|
||||
- { date: "10.01.17:", desc: "Bump to 24.2." }
|
||||
- { date: "14.10.16:", desc: "Add version layer information." }
|
||||
- { date: "17.09.16:", desc: "Rebase to alpine linux, remove redundant spotify support, move to main repository." }
|
||||
- { date: "28.02.16:", desc: "Add chromecast support, bump dependency versions." }
|
||||
- { date: "04.01.16:", desc: "Disable ipv6 by default because in v23.4 it doesn't work in unraid with it set." }
|
||||
- { date: "17.12.15:", desc: "Add in spotify support." }
|
||||
- { date: "25.11.15:", desc: "Initial Release." }
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user