33bab515cd75886780607dfd3cbb34c87f3ead92
[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 Configuration
10 =============
11
12 Running a container to play to content of your music library:
13
14   - Audio stream available from http://127.0.0.1:8001
15   - MPD available on 127.0.0.1:6601
16   - Music directory: /path/to/my/music/library
17
18 ..code-block:: sh
19     LISTEN=127.0.0.1
20     MUSIC="/path/to/my/music/library"
21     OPTIONS="-p ${LISTEN}:8001:8000"
22     OPTIONS="${OPTIONS} -p ${LISTEN}:6601:6600"
23     OPTIONS="${OPTIONS} --volume ${MUSIC}:/music:ro"
24     docker run ${OPTIONS} --detach=true --name sima kaliko/sima
25
26 To run mpd-sima with a specific configuration mount the file in the running container.
27 When /etc/mpd-sima.cfg is present in the container the default is to read it.
28
29 ..code-block:: sh
30     OPTIONS="-P --detach=true"
31     docker run -v ./my.config:/etc/mpd-sima.cfg ${OPTIONS} --name sima kaliko/sima
32     # Discover ports with "docker port sima"
33
34 Mounting your music directory and saving MPD database in ${PWD}/data:
35
36 ..code-block:: sh
37     OPTIONS="-P --detach=true"
38     docker run -v ~/Music:/music:ro -v ${PWD}/data:/var/lib/mpd ${OPTIONS} --name sima kaliko/sima
39     # Discover ports with "docker port sima"
40
41 Default option to run mpd-sima is "--log /var/log/mpd/mpd-sima.log".
42 Environment variable MPD_SIMA might be used to override default command line options.
43
44 ..code-block:: sh
45     OPTIONS="-P --detach=true"
46     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
47     # Discover ports with "docker port sima"
48
49  vim: syntax=rst ft=rst