4 This program is used to play random and chosen tracks from a collection of
5 digital audio files (for instance MP3 and OGG files). If you just set it going
6 it plays random tracks from your collection, but you can also ask for specific
7 tracks to be played, either via a command line program or a web interface, and
8 you can 'scratch' the current track.
10 See CHANGES for details of recent changes to DisOrder.
12 Currently it only runs on Linux. It could probably be ported to other UNIX
13 variants in some cases without too much effort. Things you will need:
17 libdb 4.3.29 4.2 and earlier won't work
20 libpcre 6.7 need UTF-8 support
28 Python 2.4.4 (optional)
29 GTK+ 2.8.20 (if you want the GTK+ client)
30 GLIB 2.12.4 (if you want the GTK+ client)
32 "Tested" means I've built against that version; earlier or later versions will
37 + Apache 1.3.x works for me, but anything that supports CGI and
38 authentication should be suitable.
39 * Separate player programs are no longer required (but may still be used)
41 Development dependencies (only developers will need these):
42 Automake 1.10 AM_PATH_PYTHON not good enough in 1.7
44 Libtool 1.5.22 1.4 not good enough
47 On Debian you might ensure you have the required packages as follows:
48 apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
49 libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
50 libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
54 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
55 - discussion of DisOrder (and other software), bug reports, etc
56 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
57 - announcements of new versions of DisOrder
63 "This place'd be a paradise tomorrow, if every department had a supervisor
66 NOTE: If you are upgrading from an earlier version, see README.upgrades.
68 1. Build the software. Do something like this:
70 ./configure --sysconfdir=/etc --localstatedir=/var
73 See INSTALL for more details about driving configure. The precise set of
74 options you pass to configure is up to you, if you like configuration being
75 in /usr/local/etc or wherever then that should work.
77 If you only want to build a subset of DisOrder, specify one or more of the
79 --without-server Don't build server or web interface
80 --without-gtk Don't build GTK+ client (Disobedience)
81 --without-python Don't build Python support
83 See README.client for setting up a standalone client (or read the
84 disobedience man page).
86 The server is only built by default under Linux. See README.mac concerning
89 2. Install it. Most of the installation is done via the install target:
91 make installdirs install
93 The CGI interface has to be installed separately:
95 install -m 755 clients/disorder.cgi /usr/local/lib/cgi-bin/disorder
97 3. Create a 'jukebox' user and group, with the jukebox group being the default
98 group of the jukebox user. The server will run as this user and group.
99 Check that this user can read your music files and write to the audio
100 device, e.g. by playing a track. The exact name doesn't matter, it could be
101 'jukebox' or 'disorder' or 'fred' or whatever.
103 Do not use a general-purpose user or group, you must create ones
104 specifically for DisOrder.
106 4. Create /etc/disorder/config. Start from examples/config.sample and adapt it
107 to your own requirements. In particular, you should:
108 * add 'player' commands for any file formats not supported natively
109 * edit the 'collection' command to identify the location(s) of your own
110 digital audio files. These commands also specify the encoding of
111 filenames, which you should be sure to get right as recovery from an
112 error here can be painful (see BUGS).
113 * edit the 'scratch' commands to supply scratch sounds (or delete them if
115 * edit the 'trust' command to reflect the user the web interface will
117 * edit the 'url' command to give the URL of the web interface.
118 * add or remove 'stopword' entries as necessary (these words won't take
119 part in track name searches from the web interface).
121 See disorder_config(5) for more details.
123 See README.raw for details on setting up "raw format" players, which allow
124 for pausing and gapless play.
126 5. Make sure the server is started at boot time.
128 On many Linux systems, examples/disorder.init should be more or less
129 suitable; install it in /etc/init.d, adapting it as necessary, and make
130 appropriate links from /etc/rc[0-6].d.
134 On Linux systems with sysv-style init:
136 /etc/init.d/disorder start
138 By default disorderd logs to daemon.*; check your syslog.conf to see where
139 this ends up and look for log messages from disorderd there. If it didn't
140 start up correctly there should be an error message. Correct the problem
143 7. After a minute it should start to play something. Try scratching it, as any
144 of the users you set up in step 5:
148 The track should stop playing, and (if you set any up) a scratch sound play.
150 8. Add any other users you want to config.private. Each user's password
151 should be stored in a file in their home directory, ~/.disorder/passwd,
152 which should be readable only by them, and should take the form of a single
157 (root doesn't need this as the client can read it out of config.private
158 when running as root.)
160 Note that the server must be reloaded (e.g. by 'disorder reconfigure')
161 when new users are added.
163 Alternatively the administrator can create /etc/disorder/config.USERNAME
164 containing the same thing as above. It can either be owned by the user and
165 mode 400, or owned by root and the user's group (if you have per-user
166 groups) and mode 440.
168 You can use 'disorder authorize' to automatically pick passwords and
171 9. Optionally source completion.bash from /etc/profile or similar, for
174 . /usr/local/share/disorder/completion.bash
176 This provides completion over disorder command and option names.
182 "Thought I was a gonner baby, but I'm bullet proof"
184 These instructions assumes you are using Apache 1.3.x.
186 You need to configure a number of things to make this work:
188 1. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
189 if you are somehow reading this in the 1980s) accordingly and use a fragment
192 <VirtualHost HOSTNAME>
193 DocumentRoot /home/jukebox/public_html
194 ServerName jukebox.DOMAIN
196 ServerAdmin webmaster@DOMAIN
197 ErrorLog /var/log/apache/jukebox/error.log
198 TransferLog /var/log/apache/jukebox/access.log
199 Alias /static/ /usr/local/share/disorder/static/
202 /static/ should point to the 'static' directory installed by DisOrder. If
203 you don't want to use the name 'static' then you can change the url.static
204 label in the web interface configuration to your preferred URL; see
205 disorder_config(5) for details.
207 Don't forget to reload Apache after modifying its configuration.
209 Separate logging is not required but I find it convenient. Up to you.
211 2. disorder.cgi assumes it is subject to access control (and in particular uses
212 the username to report who did what). Here's how I configured Apache, given
213 the above VirtualHost settings:
215 <Directory /home/jukebox>
219 AuthUserFile /home/jukebox/http.users
222 Adjust this according to wherever you're going to install disorder.cgi and
225 Don't forget to reload apache after modifying its configuration. If you got
226 it wrong, fix it and restart Apache.
228 3. Create the password file configured above. Something like this:
230 # htpasswd -b -c /home/jukebox/http.users myusername mypassword
231 Adding password for user myusername
232 # htpasswd -b /home/jukebox/http.users othername otherpass
233 Adding password for user othername
235 4. The jukebox must be configured to trust the web user. I added the following
236 line to my /etc/disorder/config:
240 This might not be the same on your system! You have to specify the user
241 that the CGI script runs as, whatever that is.
243 5. Install disorder.cgi in an appropriate location. Remember to make it
244 executable. With the above configuration I installed it as
245 ~jukebox/public_html/index.cgi.
247 6. Give www-data (or whatever user it is) a password and edit
248 /etc/disorder/config.private accordingly. This file should be mode 640 and
249 owned by root:jukebox. The line should look something like this:
251 allow www-data MYPASSWORD
253 After editing the config file, you must make the daemon re-read it:
257 7. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
258 This file should be mode 640 and owned by root:www-data.
262 (You could also use ~www-data/.disorder/passwd for this but on some systems
263 the web server user's home directory is inside the document root, which
264 would have rather unfortunate consequences.)
266 8. Try it out. You should be asked for a username and password that you
267 configured earlier, and be shown details of what is playing and what other
268 tracks have been configured for future play.
270 9. Some features take time to start working, for instance those involving
271 reporting the length of tracks. This is because the server starts up as
272 quickly as possible even if the full track data has not yet been gathered;
273 the track data is then calculated in the background.
275 10. If you run into problems, always look at the appropriate error log; the
276 message you see in your web browser will usually not be sufficient to
277 diagnose the problem all by itself.
279 11. If you have a huge number of top level directories, then you might find
280 that the 'Choose' page is unreasonably large. If so add the following line
281 to /etc/disorder/options.user:
282 label sidebar.choosewhich choosealpha
284 This will make 'Choose' be a link for each letter of the 26-letter Roman
285 alphabet; follow the link and you just get the directories which start with
286 that letter. The "*" link at the end gives you directories which don't
289 You can copy choosealpha.html to /etc/disorder and edit it to change the
290 set of initial choices to anything that can be expressed with regexps. The
291 regexps must be URL-encoded UTF-8 PCRE regexps.
297 "Nothing but another drug, a licence that you buy and sell"
299 DisOrder - select and play digital audio files
300 Copyright (C) 2003-2007 Richard Kettlewell
301 Portions extracted from MPG321, http://mpg321.sourceforge.net/
302 Copyright (C) 2001 Joe Drew
303 Copyright (C) 2000-2001 Robert Leslie
304 Binaries may derive extra copyright owners through linkage (binary distributors
305 are expected to do their own legwork)
307 This program is free software; you can redistribute it and/or modify it under
308 the terms of the GNU General Public License as published by the Free Software
309 Foundation; either version 2 of the License, or (at your option) any later
312 This program is distributed in the hope that it will be useful, but WITHOUT ANY
313 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
314 PARTICULAR PURPOSE. See the GNU General Public License for more details.
316 You should have received a copy of the GNU General Public License along with
317 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
318 Place, Suite 330, Boston, MA 02111-1307 USA