27e1c8ca77a7ecef97090b03c05d1d8d3e756c0c
[sima-docker.git] / README.rst
1 Description
2 ===========
3
4 This image contains MPD, icecast2 and MPD_sima in order to serve an audio stream over http.
5
6 MPD is looking for music in */music* (``music_directory`` option) and keeps its
7 dataset in */var/lib/mpd* (options: ``playlist_directory``, ``{db,sticker,state}_file``).
8
9 tl;dr
10 =====
11
12 Build an image and run a container out of it::
13
14     ./do build  # optional but then it'll fetch an image from hub.docker.com
15     MUSIC=/pat/to/my/music/library ./do run
16
17 Then point your MPD client to ``localhost:6601``.
18
19 Configuration
20 =============
21
22 Running a container to play to content of your music library:
23
24 ::
25
26     LISTEN=127.0.0.1
27     MUSIC="/path/to/my/music/library"
28     OPTIONS="-p ${LISTEN}:8001:8000"
29     OPTIONS="${OPTIONS} -p ${LISTEN}:6601:6600"
30     OPTIONS="${OPTIONS} --volume ${MUSIC}:/music:ro"
31     docker run ${OPTIONS} --name sima kaliko/sima
32
33 The container ``sima`` is running with the following configuration:
34
35   - Music directory: /path/to/my/music/library
36   - Audio stream available from http://127.0.0.1:8001
37   - MPD available on 127.0.0.1:6601
38
39
40 To run mpd-sima with a specific configuration mount the file in the running container.
41 When /etc/mpd-sima.cfg is present in the container the default is to read it.
42
43 ::
44
45     OPTIONS="-P --detach=true"
46     docker run -v ./my.config:/etc/mpd-sima.cfg ${OPTIONS} --name sima kaliko/sima
47     # Discover ports with "docker port sima"
48
49 Mounting your music directory and saving MPD database in ${PWD}/data:
50
51 ::
52
53     OPTIONS="-P --detach=true"
54     OPTIONS="${OPTIONS} -v ~/Music:/music:ro -v ${PWD}/data:/var/lib/mpd"
55     docker run ${OPTIONS} --name sima kaliko/sima
56     # Discover ports with "docker port sima"
57
58 Default option to run mpd-sima is "--log /var/log/mpd/mpd-sima.log".
59 Environment variable MPD_SIMA might be used to override default command line options:
60
61 ::
62
63     OPTIONS="-P --detach=true"
64     docker run --env="MPD_SIMA=--log-level debug --log /var/log/mpd/mpd-sima.log" -v ${PWD}/log:/var/log/mpd ${OPTIONS} --name sima kaliko/sima
65     # Discover ports with "docker port sima"