Skip to content

Commit 81b1957

Browse files
authored
[Documentation] Changes for vanilla images #277 (#278)
1 parent 965e2de commit 81b1957

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,42 @@ First and foremost, the reference to the awesome projects:
2525
Source: [GitHub](https://github.com/giof71/mpd-alsa-docker)
2626
Images: [DockerHub](https://hub.docker.com/r/giof71/mpd-alsa)
2727

28+
## Why
29+
30+
I prepared this Dockerfile because I wanted to be able to install mpd easily on any machine (provided the architecture is amd64 or arm). Also I wanted to be able to configure and govern the parameters easily, allowing multiple output, also of different types.
31+
32+
## Prerequisites
33+
34+
See [this](https://github.com/GioF71/mpd-alsa-docker/blob/main/doc/prerequisites.md) page.
35+
36+
## Get the image
37+
38+
Here is the [repository](https://hub.docker.com/r/giof71/mpd-alsa) on DockerHub.
39+
40+
Getting the image from DockerHub is as simple as typing:
41+
42+
`docker pull giof71/mpd-alsa`
43+
44+
Legacy support `OUTPUT_MODE`, is still available in the `legacy` branch, as well as on the images tagged with the `legacy` prefix.
45+
You might want to use those releases as a stop-gap solution should you encounter issues migrating to the new configuration methods.
46+
Keep in mind that the `legacy` branch will not be updated with new features. Only relevant bugfix changes will be ported there.
47+
2848
## MPD Source code
2949

30-
The source code is in this GitHub [repo](https://github.com/GioF71/MPD).
50+
The source code for the patched MPD is in this GitHub [repo](https://github.com/GioF71/MPD).
3151
The `version-0.23.12` tag is in-line with the GitHub [upstream repo](https://github.com/MusicPlayerDaemon/MPD) at version 0.23.12.
3252
The `version-0.23.12-ups` tag contains a patch which is used when `INTEGER_UPSAMPLING` is set to `yes`. Use at your own risk.
3353
Two binaries are available in the container image:
3454

3555
- /app/bin/compiled/mpd (upstream version)
3656
- /app/bin/compiled/mpd-ups (patched version)
3757

38-
The current mpd version is `v0.23.12`. I am building using [debian:bullseye-slim](https://hub.docker.com/_/debian/tags?page=1&name=bullseye-slim) (tags: `stable`, `bullseye`), [ubuntu:jammy](https://hub.docker.com/_/ubuntu/tags?page=1&name=jammy) (tags: `ubuntu-current-lts`, `jammy`) and [ubuntu:kinetic](https://hub.docker.com/_/ubuntu/tags?page=1&name=kinetic) (`latest`, `ubuntu-current`, `kinetic`) as base images.
58+
The current mpd version is `v0.23.12` when using [giof71/mpd-compiler-docker](https://github.com/GioF71/mpd-compiler-docker) as the base image (Docker Repo [here](https://hub.docker.com/r/giof71/mpd-compiler)). The repo binary is installed also in this case.
59+
Vanilla versions only have the repo binary.
3960
The `mpdscribble` version depends on the base image. See the following table:
4061

62+
### Image tags
63+
4164
Base Image|Tags|Compiled MPD version|Repo MPD version|MPDScribble version
4265
:---|:---|:---|:---|:---
4366
giof71/mpd-compiler:bookworm|**edge**, bookworm|0.23.12|0.23.12|0.24
@@ -49,26 +72,6 @@ debian:bullseye-slim|**vanilla-latest**, **vanilla-stable**, **vanilla**, vanill
4972
ubuntu:kinetic|vanilla-kinetic, vanilla-ubuntu-current|-|0.23.9|0.24
5073
ubuntu:jammy|vanilla-jammy, vanilla-ubuntu-current-lts|-|0.23.5|0.23
5174

52-
## Why
53-
54-
I prepared this Dockerfile because I wanted to be able to install mpd easily on any machine (provided the architecture is amd64 or arm). Also I wanted to be able to configure and govern the parameters easily, allowing multiple output, also of different types.
55-
56-
## Prerequisites
57-
58-
See [this](https://github.com/GioF71/mpd-alsa-docker/blob/main/doc/prerequisites.md) page.
59-
60-
## Get the image
61-
62-
Here is the [repository](https://hub.docker.com/r/giof71/mpd-alsa) on DockerHub.
63-
64-
Getting the image from DockerHub is as simple as typing:
65-
66-
`docker pull giof71/mpd-alsa`
67-
68-
Legacy support `OUTPUT_MODE`, is still available in the `legacy` branch, as well as on the images tagged with the `legacy` prefix.
69-
You might want to use those releases as a stop-gap solution should you encounter issues migrating to the new configuration methods.
70-
Keep in mind that the `legacy` branch will not be updated with new features. Only relevant bugfix changes will be ported there.
71-
7275
## Usage
7376

7477
### Important changes

0 commit comments

Comments
 (0)