Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Commit 25a6a29

Browse files
Bot Updating Templated Files
1 parent 0c0eecc commit 25a6a29

2 files changed

Lines changed: 33 additions & 28 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
9696

9797
### Testing your changes
9898

99-
```
99+
```bash
100100
git clone https://github.com/linuxserver/docker-daapd.git
101101
cd docker-daapd
102102
docker build \
@@ -106,13 +106,14 @@ docker build \
106106
```
107107

108108
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109-
```
109+
110+
```bash
110111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111112
```
112113

113114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114115

115-
## Update the chagelog
116+
## Update the changelog
116117

117118
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-daapd/tree/master/root), add an entry to the changelog
118119

README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the CONTRIBUTING.md -->
2+
<!-- Please read the https://github.com/linuxserver/docker-daapd/blob/master/.github/CONTRIBUTING.md -->
33

44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
55

@@ -12,13 +12,14 @@
1212

1313
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
1414

15-
* regular and timely application updates
16-
* easy user mappings (PGID, PUID)
17-
* custom base image with s6 overlay
18-
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19-
* regular security updates
15+
* regular and timely application updates
16+
* easy user mappings (PGID, PUID)
17+
* custom base image with s6 overlay
18+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19+
* regular security updates
2020

2121
Find us at:
22+
2223
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2324
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
2425
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -56,6 +57,13 @@ The architectures supported by this image are:
5657
| arm64 | arm64v8-latest |
5758
| armhf | arm32v7-latest |
5859

60+
## Application Setup
61+
62+
Map your music folder, open up itunes on the same LAN to see your music there.
63+
64+
The web interface is available at `http://<your ip>:3689`
65+
66+
For further setup options of remotes etc, check out the daapd website, [Forked-daapd](https://ejurgensen.github.io/forked-daapd/).
5967

6068
## Usage
6169

@@ -85,7 +93,7 @@ services:
8593
8694
### docker cli
8795
88-
```
96+
```bash
8997
docker run -d \
9098
--name=daapd \
9199
--net=host \
@@ -98,7 +106,6 @@ docker run -d \
98106
ghcr.io/linuxserver/daapd
99107
```
100108

101-
102109
## Parameters
103110

104111
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.
@@ -118,7 +125,7 @@ You can set any environment variable from a file by using a special prepend `FIL
118125

119126
As an example:
120127

121-
```
128+
```bash
122129
-e FILE__PASSWORD=/run/secrets/mysecretpassword
123130
```
124131

@@ -137,28 +144,17 @@ Ensure any volume directories on the host are owned by the same user you specify
137144

138145
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
139146

140-
```
147+
```bash
141148
$ id username
142149
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
143150
```
144151

145-
146-
&nbsp;
147-
## Application Setup
148-
149-
Map your music folder, open up itunes on the same LAN to see your music there.
150-
151-
The web interface is available at `http://<your ip>:3689`
152-
153-
For further setup options of remotes etc, check out the daapd website, [Forked-daapd](https://ejurgensen.github.io/forked-daapd/).
154-
155-
156152
## Docker Mods
153+
157154
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=daapd&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.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
158155

159156
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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
160157

161-
162158
## Support Info
163159

164160
* Shell access whilst the container is running: `docker exec -it daapd /bin/bash`
@@ -175,38 +171,45 @@ Most of our images are static, versioned, and require an image update and contai
175171
Below are the instructions for updating containers:
176172

177173
### Via Docker Compose
174+
178175
* Update all images: `docker-compose pull`
179176
* or update a single image: `docker-compose pull daapd`
180177
* Let compose update all containers as necessary: `docker-compose up -d`
181178
* or update a single container: `docker-compose up -d daapd`
182179
* You can also remove the old dangling images: `docker image prune`
183180

184181
### Via Docker Run
182+
185183
* Update the image: `docker pull ghcr.io/linuxserver/daapd`
186184
* Stop the running container: `docker stop daapd`
187185
* Delete the container: `docker rm daapd`
188186
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
189187
* You can also remove the old dangling images: `docker image prune`
190188

191189
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
190+
192191
* Pull the latest image at its tag and replace it with the same env variables in one run:
193-
```
192+
193+
```bash
194194
docker run --rm \
195195
-v /var/run/docker.sock:/var/run/docker.sock \
196196
containrrr/watchtower \
197197
--run-once daapd
198198
```
199+
199200
* You can also remove the old dangling images: `docker image prune`
200201

201202
**Note:** 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](https://docs.linuxserver.io/general/docker-compose).
202203

203204
### Image Update Notifications - Diun (Docker Image Update Notifier)
205+
204206
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
205207

206208
## Building locally
207209

208210
If you want to make local modifications to these images for development purposes or just to customize the logic:
209-
```
211+
212+
```bash
210213
git clone https://github.com/linuxserver/docker-daapd.git
211214
cd docker-daapd
212215
docker build \
@@ -216,7 +219,8 @@ docker build \
216219
```
217220

218221
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
219-
```
222+
223+
```bash
220224
docker run --rm --privileged multiarch/qemu-user-static:register --reset
221225
```
222226

0 commit comments

Comments
 (0)