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