4 DisOrder 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
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").
16 See CHANGES for details of recent changes to DisOrder.
18 The server supports Linux and can be made to on a Mac. The clients work on
19 both Linux and the Mac. It could probably be ported to some other UNIX
20 variants in without too much effort. Things you will need:
24 libdb 4.3.29 4.2 and earlier won't work
27 libpcre 6.7 need UTF-8 support
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)
40 "Tested" means I've built against that version; earlier or later versions will
45 + Apache 1.3.x works for me, but anything that supports CGI and
46 authentication should be suitable.
47 * Separate player programs are no longer required (but may still be used)
49 Development dependencies (only developers will need these):
50 Automake 1.10 AM_PATH_PYTHON not good enough in 1.7
52 Libtool 1.5.22 1.4 not good enough
55 On 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 \
58 libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
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
71 "This place'd be a paradise tomorrow, if every department had a supervisor
74 NOTE: If you are upgrading from an earlier version, see README.upgrades.
76 1. Build the software. Do something like this:
78 ./configure --sysconfdir=/etc --localstatedir=/var
81 See INSTALL for more details about driving configure. The precise set of
82 options you pass to configure is up to you, if you like configuration being
83 in /usr/local/etc or wherever then that should work.
85 If you only want to build a subset of DisOrder, specify one or more of the
87 --without-server Don't build server or web interface
88 --without-gtk Don't build GTK+ client (Disobedience)
89 --without-python Don't build Python support
91 See README.client for setting up a standalone client (or read the
92 disobedience man page).
94 The server is only built by default under Linux. See README.mac concerning
97 2. Install it. Most of the installation is done via the install target:
99 make installdirs install
101 The CGI interface has to be installed separately:
103 install -m 755 clients/disorder.cgi /usr/local/lib/cgi-bin/disorder
105 3. Create a 'jukebox' user and group, with the jukebox group being the default
106 group of the jukebox user. The server will run as this user and group.
107 Check that this user can read your music files and write to the audio
108 device, e.g. by playing a track. The exact name doesn't matter, it could be
109 'jukebox' or 'disorder' or 'fred' or whatever.
111 Do not use a general-purpose user or group, you must create ones
112 specifically for DisOrder.
114 4. Create /etc/disorder/config. Start from examples/config.sample and adapt it
115 to your own requirements. In particular, you should:
116 * add 'player' commands for any file formats not supported natively
117 * edit the 'collection' command to identify the location(s) of your own
118 digital audio files. These commands also specify the encoding of
119 filenames, which you should be sure to get right as recovery from an
120 error here can be painful (see BUGS).
121 * edit the 'scratch' commands to supply scratch sounds (or delete them if
123 * edit the 'trust' command to reflect the user the web interface will
125 * edit the 'url' command to give the URL of the web interface.
126 * add or remove 'stopword' entries as necessary (these words won't take
127 part in track name searches from the web interface).
129 See disorder_config(5) for more details.
131 See README.raw for details on setting up "raw format" players, which allow
132 for pausing and gapless play.
134 5. Make sure the server is started at boot time.
136 On many Linux systems, examples/disorder.init should be more or less
137 suitable; install it in /etc/init.d, adapting it as necessary, and make
138 appropriate links from /etc/rc[0-6].d.
142 On Linux systems with sysv-style init:
144 /etc/init.d/disorder start
146 By default disorderd logs to daemon.*; check your syslog.conf to see where
147 this ends up and look for log messages from disorderd there. If it didn't
148 start up correctly there should be an error message. Correct the problem
151 7. After a minute it should start to play something. Try scratching it:
155 The track should stop playing, and (if you set any up) a scratch sound play.
157 8. Add any other users you want. These easiest way to do this is:
159 disorder authorize USERNAME
161 This will automatically choose a random password and add new line to
162 /etc/disorder/config.private and create /etc/disorder/config.USERNAME.
164 Those users should now be able to access the server from the same host as it
165 runs on, either via the disorder command or Disobedience. To run
166 Disobedience from some other host, File->Login allows hostnames, passwords
167 etc to be configured.
169 9. Optionally source completion.bash from /etc/profile or similar, for
172 . /usr/local/share/disorder/completion.bash
174 This provides completion over disorder command and option names.
180 "Thought I was a gonner baby, but I'm bullet proof"
182 These instructions assumes you are using Apache 1.3.x.
184 You need to configure a number of things to make this work:
186 1. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
187 if you are somehow reading this in the 1980s) accordingly and use a fragment
190 <VirtualHost HOSTNAME>
191 DocumentRoot /home/jukebox/public_html
192 ServerName jukebox.DOMAIN
194 ServerAdmin webmaster@DOMAIN
195 ErrorLog /var/log/apache/jukebox/error.log
196 TransferLog /var/log/apache/jukebox/access.log
197 Alias /static/ /usr/local/share/disorder/static/
200 /static/ should point to the 'static' directory installed by DisOrder. If
201 you don't want to use the name 'static' then you can change the url.static
202 label in the web interface configuration to your preferred URL; see
203 disorder_config(5) for details.
205 Don't forget to reload Apache after modifying its configuration.
207 Separate logging is not required but I find it convenient. Up to you.
209 2. disorder.cgi assumes it is subject to access control (and in particular uses
210 the username to report who did what). Here's how I configured Apache, given
211 the above VirtualHost settings:
213 <Directory /home/jukebox>
217 AuthUserFile /home/jukebox/http.users
220 Adjust this according to wherever you're going to install disorder.cgi and
223 Don't forget to reload apache after modifying its configuration. If you got
224 it wrong, fix it and restart Apache.
226 3. Create the password file configured above. Something like this:
228 # htpasswd -b -c /home/jukebox/http.users myusername mypassword
229 Adding password for user myusername
230 # htpasswd -b /home/jukebox/http.users othername otherpass
231 Adding password for user othername
233 4. The jukebox must be configured to trust the web user. I added the following
234 line to my /etc/disorder/config:
238 This might not be the same on your system! You have to specify the user
239 that the CGI script runs as, whatever that is.
241 5. Install disorder.cgi in an appropriate location. Remember to make it
242 executable. With the above configuration I installed it as
243 ~jukebox/public_html/index.cgi.
245 6. Give www-data (or whatever user it is) a password and edit
246 /etc/disorder/config.private accordingly. This file should be mode 640 and
247 owned by root:jukebox. The line should look something like this:
249 allow www-data MYPASSWORD
251 After editing the config file, you must make the daemon re-read it:
255 7. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
256 This file should be mode 640 and owned by root:www-data.
260 (You could also use ~www-data/.disorder/passwd for this but on some systems
261 the web server user's home directory is inside the document root, which
262 would have rather unfortunate consequences.)
264 8. Try it out. You should be asked for a username and password that you
265 configured earlier, and be shown details of what is playing and what other
266 tracks have been configured for future play.
268 9. Some features take time to start working, for instance those involving
269 reporting the length of tracks. This is because the server starts up as
270 quickly as possible even if the full track data has not yet been gathered;
271 the track data is then calculated in the background.
273 10. If you run into problems, always look at the appropriate error log; the
274 message you see in your web browser will usually not be sufficient to
275 diagnose the problem all by itself.
277 11. If you have a huge number of top level directories, then you might find
278 that the 'Choose' page is unreasonably large. If so add the following line
279 to /etc/disorder/options.user:
280 label sidebar.choosewhich choosealpha
282 This will make 'Choose' be a link for each letter of the 26-letter Roman
283 alphabet; follow the link and you just get the directories which start with
284 that letter. The "*" link at the end gives you directories which don't
287 You can copy choosealpha.html to /etc/disorder and edit it to change the
288 set of initial choices to anything that can be expressed with regexps. The
289 regexps must be URL-encoded UTF-8 PCRE regexps.
295 "Nothing but another drug, a licence that you buy and sell"
297 DisOrder - select and play digital audio files
298 Copyright (C) 2003-2007 Richard Kettlewell
299 Portions extracted from MPG321, http://mpg321.sourceforge.net/
300 Copyright (C) 2001 Joe Drew
301 Copyright (C) 2000-2001 Robert Leslie
302 Binaries may derive extra copyright owners through linkage (binary distributors
303 are expected to do their own legwork)
305 This program is free software; you can redistribute it and/or modify it under
306 the terms of the GNU General Public License as published by the Free Software
307 Foundation; either version 2 of the License, or (at your option) any later
310 This program is distributed in the hope that it will be useful, but WITHOUT ANY
311 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
312 PARTICULAR PURPOSE. See the GNU General Public License for more details.
314 You should have received a copy of the GNU General Public License along with
315 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
316 Place, Suite 330, Boston, MA 02111-1307 USA