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.21 4.2 and earlier won't work
20 libpcre 4.5 need UTF-8 support
28 "Tested" means I've built against that version; earlier or later versions will
33 + ogg123 and mpg321 work for me, but you could potentially use others.
35 + Apache 1.3.x works for me, but anything that supports CGI and
36 authentication should be suitable.
38 Development dependencies (only developers will need these):
39 Automake 1.9.4 AM_PATH_PYTHON not good enough in 1.7
41 Libtool 1.5.6 1.4 not good enough
44 On Debian you might ensure you have the required packages as follows:
45 apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
46 libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
47 libao-dev libmad0-dev libasound2-dev libdb-dev
50 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
51 - discussion of DisOrder (and other software), bug reports, etc
52 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
53 - announcements of new versions of DisOrder
59 "This place'd be a paradise tomorrow, if every department had a supervisor
62 NOTE: If you are upgrading from an earlier version, see README.upgrades.
64 1. Build the software. Do something like this:
66 ./configure --sysconfdir=/etc --localstatedir=/var
69 See INSTALL for more details about driving configure. The precise set of
70 options you pass to configure is up to you, if you like configuration being
71 in /usr/local/etc or wherever then that should work.
73 If you only want to build a subset of DisOrder, specify one or more of the
75 --without-server Don't build server or web interface
76 --without-gtk Don't build GTK+ client (Disobedience)
77 --without-python Don't build Python support
79 See README.client for setting up a standalone client.
81 2. Install it. Most of the installation is done via the install target:
83 make installdirs install
85 The CGI interface has to be installed separately, and you must use Libtool
86 to install it. For instance:
88 ./libtool --mode=install install -m 755 progs/disorder.cgi /usr/local/lib/cgi-bin/disorder
90 Depending on how your system is configured you may need to link the disorder
91 libao driver into the right directory:
93 ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
95 3. Create a 'jukebox' user and group, with the jukebox group being the default
96 group of the jukebox user. The server will run as this user and group.
97 Check that this user can read your music files and write to the audio
98 device, e.g. by playing a track. The exact name doesn't matter, it could be
99 'jukebox' or 'disorder' or 'fred' or whatever.
101 Do not use a general-purpose user or group, you must create ones
102 specifically for DisOrder.
104 4. Create /etc/disorder/config. Start from examples/config.sample and adapt it
105 to your own requirements. In particular, you should:
106 * edit the 'player' commands to reflect the software you have installed.
107 * edit the 'collection' command to identify the location(s) of your own
108 digital audio files. These commands also specify the encoding of
109 filenames, which you should be sure to get right as recovery from an
110 error here can be painful (see BUGS).
111 * edit the 'scratch' commands to supply scratch sounds (or delete them if
113 * edit the 'trust' command to reflect the user the web interface will
115 * edit the 'url' command to give the URL of the web interface.
116 * add or remove 'stopword' entries as necessary (these words won't take
117 part in track name searches from the web interface).
119 See disorder_config(5) for more details.
121 See README.raw for details on setting up "raw format" players, which allow
122 for pausing and gapless play.
124 5. Create /etc/disorder/config.private. This should be readable only by the
127 touch /etc/disorder/config.private
128 chown root:jukebox /etc/disorder/config.private
129 chmod 640 /etc/disorder/config.private
131 Set up a username and password for root, for example with line like this:
133 allow root somepassword
135 Use (for instance) pwgen(1) to create the password. DO NOT use your root
136 password - this is a password to give root access to the server, not to give
137 access to the root login.
139 See disorderd(8) and disorder_config(5) for more details.
141 6. Make sure the server is started at boot time.
143 On many Linux systems, examples/disorder.init should be more or less
144 suitable; install it in /etc/init.d, adapting it as necessary, and make
145 appropriate links from /etc/rc[0-6].d.
147 For Mac OS X 10.4, a suitable plist file is automatically installed. The
152 ...should show "uk.org.greenend.rjk.disorder" (among other things).
154 If you have a some other init system then you are on your own.
156 7. Make sure the state directory (/var/disorder or /usr/local/var/disorder or
157 as determined by configure) exists and is writable by the jukebox user.
159 mkdir -m 755 /var/disorder
160 chown disorder:root /var/disorder
162 If you want to use some other directory you must put use the 'home' command
163 in the configuration file.
167 On Linux systems with sysv-style init:
169 /etc/init.d/disorder start
173 sudo launchctl start uk.org.greenend.rjk.disorder
175 By default disorderd logs to daemon.*; check your syslog.conf to see where
176 this ends up and look for log messages from disorderd there. If it didn't
177 start up correctly there should be an error message. Correct the problem
180 9. After a minute it should start to play something. Try scratching it, as any
181 of the users you set up in step 5:
185 The track should stop playing, and (if you set any up) a scratch sound play.
187 10. Add any other users you want to config.private. Each user's password
188 should be stored in a file in their home directory, ~/.disorder/passwd,
189 which should be readable only by them, and should take the form of a single
194 (root doesn't need this as the client can read it out of config.private
195 when running as root.)
197 Note that the server must be reloaded (e.g. by 'disorder reconfigure')
198 when new users are added.
200 Alternatively the administrator can create /etc/disorder/config.USERNAME
201 containing the same thing as above. It can either be owned by the user and
202 mode 400, or owned by root and the user's group (if you have per-user
203 groups) and mode 440.
205 You can use 'disorder authorize' to automatically pick passwords and
208 11. Optionally source completion.bash from /etc/profile or similar, for
211 . /usr/local/share/disorder/completion.bash
213 This provides completion over disorder command and option names.
219 "Thought I was a gonner baby, but I'm bullet proof"
221 These instructions assumes you are using Apache 1.3.x.
223 You need to configure a number of things to make this work:
225 1. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
226 if you are somehow reading this in the 1980s) accordingly and use a fragment
229 <VirtualHost HOSTNAME>
230 DocumentRoot /home/jukebox/public_html
231 ServerName jukebox.DOMAIN
233 ServerAdmin webmaster@DOMAIN
234 ErrorLog /var/log/apache/jukebox/error.log
235 TransferLog /var/log/apache/jukebox/access.log
236 Alias /static/ /usr/local/share/disorder/static/
239 /static/ should point to the 'static' directory installed by DisOrder. If
240 you don't want to use the name 'static' then you can change the url.static
241 label in the web interface configuration to your preferred URL; see
242 disorder_config(5) for details.
244 Don't forget to reload Apache after modifying its configuration.
246 Separate logging is not required but I find it convenient. Up to you.
248 2. disorder.cgi assumes it is subject to access control (and in particular uses
249 the username to report who did what). Here's how I configured Apache, given
250 the above VirtualHost settings:
252 <Directory /home/jukebox>
256 AuthUserFile /home/jukebox/http.users
259 Adjust this according to wherever you're going to install disorder.cgi and
262 Don't forget to reload apache after modifying its configuration. If you got
263 it wrong, fix it and restart Apache.
265 3. Create the password file configured above. Something like this:
267 # htpasswd -b -c /home/jukebox/http.users myusername mypassword
268 Adding password for user myusername
269 # htpasswd -b /home/jukebox/http.users othername otherpass
270 Adding password for user othername
272 4. The jukebox must be configured to trust the web user. I added the following
273 line to my /etc/disorder/config:
277 This might not be the same on your system! You have to specify the user
278 that the CGI script runs as, whatever that is.
280 5. Install disorder.cgi in an appropriate location. Remember to make it
281 executable. With the above configuration I installed it as
282 ~jukebox/public_html/index.cgi.
284 6. Give www-data (or whatever user it is) a password and edit
285 /etc/disorder/config.private accordingly. This file should be mode 640 and
286 owned by root:jukebox. The line should look something like this:
288 allow www-data MYPASSWORD
290 After editing the config file, you must make the daemon re-read it:
294 7. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
295 This file should be mode 640 and owned by root:www-data.
299 (You could also use ~www-data/.disorder/passwd for this but on some systems
300 the web server user's home directory is inside the document root, which
301 would have rather unfortunate consequences.)
303 8. Try it out. You should be asked for a username and password that you
304 configured earlier, and be shown details of what is playing and what other
305 tracks have been configured for future play.
307 9. Some features take time to start working, for instance those involving
308 reporting the length of tracks. This is because the server starts up as
309 quickly as possible even if the full track data has not yet been gathered;
310 the track data is then calculated in the background.
312 10. If you run into problems, always look at the appropriate error log; the
313 message you see in your web browser will usually not be sufficient to
314 diagnose the problem all by itself.
316 11. If you have a huge number of top level directories, then you might find
317 that the 'Choose' page is unreasonably large. If so add the following line
318 to /etc/disorder/options.user:
319 label sidebar.choosewhich choosealpha
321 This will make 'Choose' be a link for each letter of the 26-letter Roman
322 alphabet; follow the link and you just get the directories which start with
323 that letter. The "*" link at the end gives you directories which don't
326 You can copy choosealpha.html to /etc/disorder and edit it to change the
327 set of initial choices to anything that can be expressed with regexps. The
328 regexps must be URL-encoded UTF-8 PCRE regexps.
334 "Nothing but another drug, a licence that you buy and sell"
336 DisOrder - select and play digital audio files
337 Copyright (C) 2003-2007 Richard Kettlewell
338 Portions extracted from MPG321, http://mpg321.sourceforge.net/
339 Copyright (C) 2001 Joe Drew
340 Copyright (C) 2000-2001 Robert Leslie
341 Binaries may derive extra copyright owners through linkage (binary distributors
342 are expected to do their own legwork)
344 This program is free software; you can redistribute it and/or modify it under
345 the terms of the GNU General Public License as published by the Free Software
346 Foundation; either version 2 of the License, or (at your option) any later
349 This program is distributed in the hope that it will be useful, but WITHOUT ANY
350 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
351 PARTICULAR PURPOSE. See the GNU General Public License for more details.
353 You should have received a copy of the GNU General Public License along with
354 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
355 Place, Suite 330, Boston, MA 02111-1307 USA