chiark / gitweb /
init script now uses start-stop-daemon if available (i.e. on Debian
[disorder] / README
CommitLineData
460b9539 1DisOrder
2========
3
9025afab
RK
4DisOrder is a multi-user software jukebox.
5 * It can play either selected tracks or pick tracks at random.
6 * It supports OGG, MP3, FLAC and WAV files, and can be configured to support
7 anything you can supply a player for (up to a point).
8 * It supports both ALSA and OSS and can also broadcast an RTP stream over a
9 LAN; a player for the latter is included.
10 * Tracks may be selected either via a hierarchical interface or by a fast
11 word search.
12 * It has a web interface (allowing access from graphical web browsers) and a
13 GTK+ interface that runs on Linux and Mac systems.
14 * Playing tracks can be paused or cancelled ("scratched").
460b9539 15
16See CHANGES for details of recent changes to DisOrder.
17
5f5fc693
RK
18The server supports Linux and can be made to work on a Mac (see README.mac).
19The clients work on both Linux and the Mac. It could probably be ported to
20some other UNIX variants without too much effort. Things you will need:
460b9539 21
22Build dependencies:
23 Name Tested Notes
662886f6 24 libdb 4.3.29 not 4.2.x; 4.4+ might work.
1a0d3568 25 libgc 6.8
26 libvorbisfile 1.1.2
27 libpcre 6.7 need UTF-8 support
460b9539 28 libmad 0.15.1b
1a0d3568 29 libgcrypt 1.2.3
460b9539 30 libao 0.8.6
1a0d3568 31 libasound 1.0.13
32 libFLAC 1.1.2
33 GNU C 4.1.2
34 GNU Make 3.81
ddf922de 35 GNU Sed 4.1.5
1a0d3568 36 Python 2.4.4 (optional)
37 GTK+ 2.8.20 (if you want the GTK+ client)
38 GLIB 2.12.4 (if you want the GTK+ client)
460b9539 39
40"Tested" means I've built against that version; earlier or later versions will
41often work too.
42
43Runtime dependencies:
460b9539 44 * Web server:
45 + Apache 1.3.x works for me, but anything that supports CGI and
46 authentication should be suitable.
1a0d3568 47 * Separate player programs are no longer required (but may still be used)
460b9539 48
49Development dependencies (only developers will need these):
1a0d3568 50 Automake 1.10 AM_PATH_PYTHON not good enough in 1.7
51 Autoconf 2.61
52 Libtool 1.5.22 1.4 not good enough
39068fb4 53 Bazaar (bzr)
460b9539 54
e9194ec6 55On Debian you might ensure you have the required packages as follows:
56 apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
57 libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
1a0d3568 58 libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
59 libflac-dev
e9194ec6 60
460b9539 61Mailing lists:
62 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
63 - discussion of DisOrder (and other software), bug reports, etc
64 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
65 - announcements of new versions of DisOrder
66
67
68Installation
69============
70
71 "This place'd be a paradise tomorrow, if every department had a supervisor
72 with a machine-gun"
73
74NOTE: If you are upgrading from an earlier version, see README.upgrades.
75
5f5fc693
RK
76On a Debian system, if you install from .deb files then you should be able to
77skip steps 1 to 6 and configure it via debconf. This is strongly recommended!
78
460b9539 791. Build the software. Do something like this:
80
81 ./configure --sysconfdir=/etc --localstatedir=/var
82 make
83
84 See INSTALL for more details about driving configure. The precise set of
85 options you pass to configure is up to you, if you like configuration being
86 in /usr/local/etc or wherever then that should work.
87
88 If you only want to build a subset of DisOrder, specify one or more of the
89 following options:
90 --without-server Don't build server or web interface
91 --without-gtk Don't build GTK+ client (Disobedience)
92 --without-python Don't build Python support
93
655cae67
RK
94 See README.client for setting up a standalone client (or read the
95 disobedience man page).
96
460b9539 972. Install it. Most of the installation is done via the install target:
98
99 make installdirs install
100
813070ec
RK
101 The CGI interface has to be installed separately; see under 'Web Interface'
102 below.
460b9539 103
460b9539 1043. Create a 'jukebox' user and group, with the jukebox group being the default
105 group of the jukebox user. The server will run as this user and group.
106 Check that this user can read your music files and write to the audio
107 device, e.g. by playing a track. The exact name doesn't matter, it could be
108 'jukebox' or 'disorder' or 'fred' or whatever.
109
110 Do not use a general-purpose user or group, you must create ones
111 specifically for DisOrder.
112
1134. Create /etc/disorder/config. Start from examples/config.sample and adapt it
be2d9f37 114 to your own requirements. The things you MUST do are:
460b9539 115 * edit the 'collection' command to identify the location(s) of your own
116 digital audio files. These commands also specify the encoding of
117 filenames, which you should be sure to get right as recovery from an
118 error here can be painful (see BUGS).
be2d9f37
RK
119 Optionally you may also want to do the following:
120 * add 'player' commands for any file formats not supported natively
460b9539 121 * edit the 'scratch' commands to supply scratch sounds (or delete them if
122 you don't want any).
460b9539 123 * add or remove 'stopword' entries as necessary (these words won't take
124 part in track name searches from the web interface).
125
126 See disorder_config(5) for more details.
127
da6f7693
RK
128 See README.streams for how to set up network play.
129
130 If adding new 'player' commands, see README.raw for details on setting up
131 "raw format" players. Non-raw players are still supported but not in all
662886f6 132 configurations and they cannot support pausing and gapless play. If you
133 want additional formats to be supported natively please point the author at
134 a GPL-compatible library that can decode them.
6e2c9f5f 135
36be7e6a 1365. Make sure the server is started at boot time.
e83d0967
RK
137
138 On many Linux systems, examples/disorder.init should be more or less
139 suitable; install it in /etc/init.d, adapting it as necessary, and make
140 appropriate links from /etc/rc[0-6].d.
141
36be7e6a 1426. Start the server.
e83d0967
RK
143
144 On Linux systems with sysv-style init:
460b9539 145
146 /etc/init.d/disorder start
147
148 By default disorderd logs to daemon.*; check your syslog.conf to see where
149 this ends up and look for log messages from disorderd there. If it didn't
150 start up correctly there should be an error message. Correct the problem
151 and try again.
152
01f400ed
RK
1537. After a short while it should start to play something. Try scratching it
154 (as root):
460b9539 155
156 disorder scratch
157
158 The track should stop playing, and (if you set any up) a scratch sound play.
159
5f5fc693
RK
1608. Add any other users you want. These easiest way to do this is (still as
161 root):
460b9539 162
8ae47ac8 163 disorder authorize USERNAME
460b9539 164
f0feb22e
RK
165 This will automatically choose a random password and create
166 /etc/disorder/config.USERNAME.
460b9539 167
9025afab
RK
168 Those users should now be able to access the server from the same host as it
169 runs on, either via the disorder command or Disobedience. To run
170 Disobedience from some other host, File->Login allows hostnames, passwords
171 etc to be configured.
172
36be7e6a
RK
1739. Optionally source completion.bash from /etc/profile or similar, for
174 example:
460b9539 175
36be7e6a 176 . /usr/local/share/disorder/completion.bash
460b9539 177
36be7e6a 178 This provides completion over disorder command and option names.
460b9539 179
180
181Web Interface
182=============
183
184 "Thought I was a gonner baby, but I'm bullet proof"
185
a767291c 186As above, if you install from a .deb, much of the work will be done
187automatically.
460b9539 188
189You need to configure a number of things to make this work:
190
662886f6 1911. If you want online registration to work then set mail_sender in
e70701e7 192 /etc/disorder/config to the email address that communications from the web
563071c2 193 interface will appear to be sent. If this is not a valid, deliverable email
662886f6 194 address then the results are not likely to be reliable.
e70701e7 195
196 mail_sender webmaster@example.com
197
198 By default the web interface sends mail by connecting to the SMTP port of
199 127.0.0.1. You can override this with the smtp_server directive, for
200 exampler:
201
202 smtp_server mail.example.com
203
2042. The web interface depends on a 'guest' user existing. You can create this
5e34540b 205 with the following command:
206
207 disorder setup-guest
208
209 If you don't want to allow online registration instead use:
210
a767291c 211 disorder setup-guest --no-online-registration
5e34540b 212
a767291c 2133. Make sure that DisOrder can find its icons and stylesheet. For example in
214 your web server configuration:
460b9539 215
5e34540b 216 Alias /disorder/ /usr/local/share/disorder/static/
460b9539 217
5e34540b 218 Alternatively you could use a symlink from the right location in your
219 document root, provided your web server is configured to follow them.
220
a767291c 221 cd /var/www
222 ln -s /usr/local/share/disorder/static disorder
460b9539 223
e70701e7 2244. Install disorder.cgi in an appropriate location. Remember to make it
a767291c 225 executable. Example:
5e34540b 226
227 install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder
228
e70701e7 2295. Try it out. You should be able to perform read-only operations straight
d84bf422 230 away, and after visiting the 'Login' page to authenticate, perform other
231 operations like adding a track to the queue.
460b9539 232
e70701e7 2336. If you run into problems, always look at the appropriate error log; the
5e34540b 234 message you see in your web browser will usually not be sufficient to
235 diagnose the problem all by itself.
460b9539 236
e70701e7 2377. If you have a huge number of top level directories, then you might find
5e34540b 238 that the 'Choose' page is unreasonably large. If so add the following line
239 to /etc/disorder/options.user:
240 label sidebar.choosewhich choosealpha
241
242 This will make 'Choose' be a link for each letter of the 26-letter Roman
243 alphabet; follow the link and you just get the directories which start with
244 that letter. The "*" link at the end gives you directories which don't
245 start with a letter.
246
247 You can copy choosealpha.html to /etc/disorder and edit it to change the
248 set of initial choices to anything that can be expressed with regexps. The
249 regexps must be URL-encoded UTF-8 PCRE regexps.
460b9539 250
a767291c 251If you want to give DisOrder its own virtual host, see README.vhost.
460b9539 252
253Copyright
254=========
255
256 "Nothing but another drug, a licence that you buy and sell"
257
258DisOrder - select and play digital audio files
eb525fcd 259Copyright (C) 2003-2007 Richard Kettlewell
313acc77
RK
260Portions copyright (C) 2007 Ross Younger
261Portions copyright (C) 2007 Mark Wooding
460b9539 262Portions extracted from MPG321, http://mpg321.sourceforge.net/
263 Copyright (C) 2001 Joe Drew
264 Copyright (C) 2000-2001 Robert Leslie
265Binaries may derive extra copyright owners through linkage (binary distributors
266are expected to do their own legwork)
267
268This program is free software; you can redistribute it and/or modify it under
269the terms of the GNU General Public License as published by the Free Software
270Foundation; either version 2 of the License, or (at your option) any later
271version.
272
273This program is distributed in the hope that it will be useful, but WITHOUT ANY
274WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
275PARTICULAR PURPOSE. See the GNU General Public License for more details.
276
277You should have received a copy of the GNU General Public License along with
278this program; if not, write to the Free Software Foundation, Inc., 59 Temple
279Place, Suite 330, Boston, MA 02111-1307 USA
280
281Local Variables:
282mode:text
283fill-column:79
284End: