b1ee0d2f35091979e36775df2d0020858ea8f532
[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 ::
13
14     MUSIC=/pat/to/my/music/library ./do run
15
16 Then point your MPD client to ``127.0.0.1:6601``. Audio stream from http://127.0.0.1:8001/sima.ogg .
17
18 Configuration
19 =============
20
21 Running a container to play to content of your music library:
22
23 ::
24
25     LISTEN=127.0.0.1
26     MUSIC="/path/to/my/music/library"
27     OPTIONS="-p ${LISTEN}:8001:8000"
28     OPTIONS="${OPTIONS} -p ${LISTEN}:6601:6600"
29     OPTIONS="${OPTIONS} --volume ${MUSIC}:/music:ro"
30     docker run ${OPTIONS} --name sima kaliko/sima
31
32 The container ``sima`` is running with the following configuration:
33
34   - Music directory: /path/to/my/music/library
35   - Audio stream available from http://127.0.0.1:8001
36   - MPD available on 127.0.0.1:6601
37
38 It is quite useful to save MPD database once it has read all your Music library.
39 In order to save it for later use with another container use a volume.
40
41 Here is an example on how to mount your music directory and save MPD database in ${PWD}/data:
42
43 ::
44
45     mkdir -p ${PWD}/data
46     OPTIONS="-P --detach=true"
47     OPTIONS="${OPTIONS} -v ~/Music:/music:ro -v ${PWD}/data:/var/lib/mpd"
48     docker run ${OPTIONS} --name sima kaliko/sima
49     # Discover ports with "docker port sima"
50
51 Default option to run mpd-sima is "--log /var/log/mpd/mpd-sima.log".
52
53 Environment variable ``MPD_SIMA`` can be set to override default command line options.
54
55 This is especially useful to launch a container with preloaded configuration files:
56
57   - ``/etc/mpd-sima.album.cfg`` : Album mode queuing method
58   - ``/etc/mpd-sima.top.cfg`` : Top tracks queuing method
59
60 Running the album mode::
61
62     OPTIONS="-P --detach=true"
63     OPTIONS="${OPTIONS} -v ~/Music:/music:ro -v ${PWD}/data:/var/lib/mpd"
64     docker run --env="MPD_SIMA=--config /etc/mpd-sima.album.cfg" ${OPTIONS} --name sima kaliko/sima
65     # Discover ports with "docker port sima"
66
67
68 To run mpd-sima with your own configuration, mount the file in the running container.
69 When /etc/mpd-sima.cfg is present in the container the default is to read it.
70
71 ::
72
73     OPTIONS="-P --detach=true"
74     OPTIONS="${OPTIONS} -v ~/Music:/music:ro -v ${PWD}/data:/var/lib/mpd"
75     docker run -v ./my.config:/etc/mpd-sima.cfg ${OPTIONS} --name sima kaliko/sima
76     # Discover ports with "docker port sima"
77