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 and README.upgrades for
20 Linux Well tested on Debian
21 Mac OS X Disobedience well tested, server somewhat tested; use fink
22 FreeBSD Scantily tested; use ports for dependencies
23 It could probably be ported to some other UNIX variants without too much
28 libdb 4.3.29 not 4.2.x; 4.4+ might work.
31 libpcre 6.7 need UTF-8 support
40 Python 2.4.4 (optional)
41 GTK+ 2.8.20 (if you want the GTK+ client)
42 GLIB 2.12.4 (if you want the GTK+ client)
44 "Tested" means I've built against that version; earlier or later versions will
47 For the web interface to work you will additionally need a web server. I've
48 had both Apache 1.3.x and 2.x working. Anything that supports CGI should be
52 http://code.google.com/p/disorder/
55 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
56 - discussion of DisOrder (and other software), bug reports, etc
57 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
58 - announcements of new versions of DisOrder
60 Developers should read README.developers.
66 "This place'd be a paradise tomorrow, if every department had a supervisor
69 IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
71 Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
74 OX X/FreeBSD/other Linux: after installation (step 1) 'sudo bash scripts/setup'
75 covers steps 3 to 6. If it doesn't work on your platform, please get in touch.
77 1. Build the software. Do something like this:
80 make # on FreeBSD use gmake
82 See INSTALL or ./configure --help for more details about driving configure.
84 If you only want to build a subset of DisOrder, specify one or more of the
86 --without-server Don't build server or web interface
87 --without-gtk Don't build GTK+ client (Disobedience)
88 --without-python Don't build Python support
90 See README.client for setting up a standalone client (or read the
91 disobedience man page).
93 To build .debs on Debian/Ubuntu, use:
94 fakeroot debian/rules binary
96 2. Install it. Most of the installation is done via the install target:
98 make installdirs install
100 The CGI interface has to be installed separately; see under 'Web Interface'
103 NB steps 3 to 6 are covered by scripts/setup. It should work on FreeBSD, OS
104 X and Linux and could be adapted to other platforms.
106 3. Create a 'jukebox' user and group, with the jukebox group being the default
107 group of the jukebox user. The server will run as this user and group.
108 Check that this user can read your music files and write to the audio
109 device, e.g. by playing a track. The exact name doesn't matter, it could be
110 'jukebox' or 'disorder' or 'fred' or whatever.
112 Do not use a general-purpose user or group, you must create ones
113 specifically for DisOrder.
115 4. Create /etc/disorder/config. Start from examples/config.sample and adapt it
116 to your own requirements. The things you MUST do are:
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 Optionally you may also want to do the following:
122 * add 'player' and 'tracklength' commands for any file formats not
124 * edit the 'scratch' commands to supply scratch sounds (or delete them if
126 * add extra 'stopword' entries as necessary (these words won't take part in
127 track name searches from the web interface).
129 See disorder_config(5) for more details.
131 See README.streams for how to set up network play.
133 If adding new 'player' commands, see README.raw for details on setting up
134 "raw format" players. Non-raw players are still supported but not in all
135 configurations and they cannot support pausing and gapless play. If you
136 want additional formats to be supported natively please point the author at
137 a GPL-compatible library that can decode them.
139 5. Make sure the server is started at boot time.
141 On many Linux systems, examples/disorder.init should be more or less
142 suitable; install it in /etc/init.d, adapting it as necessary, and make
143 appropriate links from /etc/rc[0-6].d.
147 On Linux systems with sysv-style init:
149 /etc/init.d/disorder start
151 By default disorderd logs to daemon.*; check your syslog.conf to see where
152 this ends up and look for log messages from disorderd there. If it didn't
153 start up correctly there should be an error message. Correct the problem
156 7. After a short while it should start to play something. Try scratching it
161 The track should stop playing, and (if you set any up) a scratch sound play.
163 8. Add any other users you want. These easiest way to do this is (still as
166 disorder authorize USERNAME
168 This will automatically choose a random password and create
169 ~USERNAME/.disorder/passwd.
171 Those users should now be able to access the server from the same host as it
172 runs on, either via the disorder command or Disobedience. To run
173 Disobedience from some other host, File->Login allows hostnames, passwords
174 etc to be configured.
176 Alternatively, after setting up the web interface (below), it's possible to
177 allow users to register themselves without operator involvement.
179 9. Optionally source completion.bash from /etc/profile or similar, for
182 . /usr/local/share/disorder/completion.bash
184 This provides completion over disorder command and option names.
190 "Thought I was a gonner baby, but I'm bullet proof"
192 Debian/Ubuntu: the .deb files will do the setup here automatically.
194 OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
197 You need to configure a number of things to make this work:
199 1. If you want online registration to work then set mail_sender in
200 /etc/disorder/config to the email address that communications from the web
201 interface will appear to be sent. If this is not a valid, deliverable email
202 address then the results are not likely to be reliable.
204 mail_sender webmaster@example.com
206 By default the web interface sends mail by connecting to the SMTP port of
207 127.0.0.1. You can override this with the smtp_server directive, for
210 smtp_server mail.example.com
212 Use 'disorder reconfigure' to make sure the server knows these settings.
214 2. The web interface depends on a 'guest' user existing. You can create this
215 with the following command:
219 If you don't want to allow online registration instead use:
221 disorder setup-guest --no-online-registration
223 3. Make sure that DisOrder can find its icons and stylesheet. For example in
224 your web server configuration:
226 Alias /disorder/ /usr/local/share/disorder/static/
228 Alternatively you could use a symlink from the right location in your
229 document root, provided your web server is configured to follow them.
232 ln -s /usr/local/share/disorder/static disorder
234 4. Install disorder.cgi in an appropriate location. Remember to make it
237 install -m 755 server/disorder.cgi /usr/lib/cgi-bin/disorder
239 5. Try it out. You should be able to perform read-only operations straight
240 away, and after visiting the 'Login' page to authenticate, perform other
241 operations like adding a track to the queue.
243 6. If you run into problems, always look at the appropriate error log; the
244 message you see in your web browser will usually not be sufficient to
245 diagnose the problem all by itself.
247 7. If you have a huge number of top level directories, then you might find
248 that the 'Choose' page is unreasonably large. If so add the following line
249 to /etc/disorder/options.user:
250 label sidebar.choosewhich choosealpha
252 This will make 'Choose' be a link for each letter of the 26-letter Roman
253 alphabet; follow the link and you just get the directories which start with
254 that letter. The "*" link at the end gives you directories which don't
257 You can copy choosealpha.html to /etc/disorder and edit it to change the
258 set of initial choices to anything that can be expressed with regexps. The
259 regexps must be URL-encoded UTF-8 PCRE regexps.
261 If you want to give DisOrder its own virtual host, see README.vhost.
266 "Nothing but another drug, a licence that you buy and sell"
268 DisOrder - select and play digital audio files
269 Copyright (C) 2003-2008 Richard Kettlewell
270 Portions copyright (C) 2007 Ross Younger
271 Portions copyright (C) 2007 Mark Wooding
272 Portions extracted from MPG321, http://mpg321.sourceforge.net/
273 Copyright (C) 2001 Joe Drew
274 Copyright (C) 2000-2001 Robert Leslie
275 Binaries may derive extra copyright owners through linkage (binary distributors
276 are expected to do their own legwork)
278 This program is free software; you can redistribute it and/or modify it under
279 the terms of the GNU General Public License as published by the Free Software
280 Foundation; either version 2 of the License, or (at your option) any later
283 This program is distributed in the hope that it will be useful, but WITHOUT ANY
284 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
285 PARTICULAR PURPOSE. See the GNU General Public License for more details.
287 You should have received a copy of the GNU General Public License along with
288 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
289 Place, Suite 330, Boston, MA 02111-1307 USA