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.html for details of recent changes to DisOrder and
17 README.upgrades.html for upgrade instructions.
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.5.20 not 4.6; 4.[78] seem to be ok
31 libpcre 7.6 need UTF-8 support
34 libao 0.8.8 1.0.0 is broken
37 libsamplerate 0.1.4 currently optional
39 GNU Make 3.81 } Non-GNU versions will NOT work
41 Python 2.5.2 (optional; 2.4 won't work)
42 GTK+ 2.12.12 (for the GTK+ client; 2.10 & older will NOT work)
43 GLIB 2.16.6 (for the GTK+ client)
45 "Tested" means I've built against that version; earlier or later versions will
48 For the web interface to work you will additionally need a web server. I've
49 had both Apache 1.3.x and 2.x working. Anything that supports CGI should be
53 http://code.google.com/p/disorder/
56 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
57 - discussion of DisOrder (and other software), bug reports, etc
58 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
59 - announcements of new versions of DisOrder
61 Developers should read README.developers.
67 "This place'd be a paradise tomorrow, if every department had a supervisor
70 IMPORTANT: If you are upgrading from an earlier version, see
73 Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
76 OX X/FreeBSD/other Linux: after installation (step 1 and 2), running
77 'sudo bash scripts/setup' will cover steps 3 to 6. If it doesn't work on your
78 platform, please get in touch.
80 1. Build the software. Do something like this:
83 make # on FreeBSD use gmake
85 See INSTALL or ./configure --help for more details about driving configure.
87 If you only want to build a subset of DisOrder, specify one or more of the
89 --without-server Don't build server or web interface
90 --without-gtk Don't build GTK+ client (Disobedience)
91 --without-python Don't build Python support
93 If configure cannot guess where your web server keeps its HTML documents and
94 CGI programs, you may have to tell it, for instance:
96 ./configure cgiexecdir=/whatever/cgi-bin httpdir=/whatever/htdocs
98 See README.client for setting up a standalone client (or read the
99 disobedience man page).
101 To build .debs on Debian/Ubuntu, use:
102 fakeroot debian/rules binary
104 2. Install it. Most of the installation is done via the install target:
106 make installdirs install
108 NB steps 3 to 6 are covered by scripts/setup. It should work on FreeBSD, OS
109 X and Linux and could be adapted to other platforms.
111 3. Create a 'jukebox' user and group, with the jukebox group being the default
112 group of the jukebox user. The server will run as this user and group.
113 Check that this user can read your music files and write to the audio
114 device, e.g. by playing a track. The exact name doesn't matter, it could be
115 'jukebox' or 'disorder' or 'fred' or whatever.
117 Do not use a general-purpose user or group, you must create ones
118 specifically for DisOrder.
120 4. Create /etc/disorder/config. Start from examples/config.sample and adapt it
121 to your own requirements. The things you MUST do are:
122 * edit the 'collection' command to identify the location(s) of your own
123 digital audio files. These commands also specify the encoding of
124 filenames, which you should be sure to get right as recovery from an
125 error here can be painful (see BUGS).
126 Optionally you may also want to do the following:
127 * add 'player' and 'tracklength' commands for any file formats not
129 * edit the 'scratch' commands to supply scratch sounds (or delete them if
131 * add extra 'stopword' entries as necessary (these words won't take part in
132 track name searches from the web interface).
134 See disorder_config(5) for more details.
136 See README.streams for how to set up network play.
138 If adding new 'player' commands, see README.raw for details on setting up
139 "raw format" players. Non-raw players are still supported but not in all
140 configurations and they cannot support pausing and gapless play. If you
141 want additional formats to be supported natively please point the author at
142 a GPL-compatible library that can decode them.
144 5. Make sure the server is started at boot time.
146 On many Linux systems, examples/disorder.init should be more or less
147 suitable; install it in /etc/init.d, adapting it as necessary, and make
148 appropriate links from /etc/rc[0-6].d.
152 On Linux systems with sysv-style init:
154 /etc/init.d/disorder start
156 By default disorderd logs to daemon.*; check your syslog.conf to see where
157 this ends up and look for log messages from disorderd there. If it didn't
158 start up correctly there should be an error message. Correct the problem
161 7. After a short while it should start to play something. Try scratching it
166 The track should stop playing, and (if you set any up) a scratch sound play.
168 8. Add any other users you want. These easiest way to do this is (still as
171 disorder authorize USERNAME
173 This will automatically choose a random password and create
174 ~USERNAME/.disorder/passwd.
176 Those users should now be able to access the server from the same host as it
177 runs on, either via the disorder command or Disobedience. To run
178 Disobedience from some other host, File->Login allows hostnames, passwords
179 etc to be configured.
181 Alternatively, after setting up the web interface (below), it's possible to
182 allow users to register themselves without operator involvement.
184 9. Optionally source completion.bash from /etc/profile or similar, for
187 . /usr/local/share/disorder/completion.bash
189 This provides completion over disorder command and option names.
195 "Thought I was a gonner baby, but I'm bullet proof"
197 Debian/Ubuntu: the .deb files will do the setup here automatically.
199 OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
202 You need to configure a number of things to make this work:
204 1. If you want online registration to work then set mail_sender in
205 /etc/disorder/config to the email address that communications from the web
206 interface will appear to be sent. If this is not a valid, deliverable email
207 address then the results are not likely to be reliable.
209 mail_sender webmaster@example.com
211 By default the web interface sends mail via the system sendmail executable
212 (typically /usr/sbin/sendmail or /usr/lib/sendmail). You can override this
213 with the sendmail directive, for example:
215 sendmail /usr/sbin/my-sendmail
217 The executable you choose must support the -bs option. Alternatively you
218 can tell it to connect to an SMTP server via TCP, with the smtp_server
219 directive. For example:
221 smtp_server mail.example.com
223 Use 'disorder reconfigure' to make sure the server knows these settings.
225 2. The web interface depends on a 'guest' user existing. You can create this
226 with the following command:
230 If you don't want to allow online registration instead use:
232 disorder setup-guest --no-online-registration
234 3. Try it out. The url will be (something like):
236 http://localhost/cgi-bin/disorder
238 You should be able to perform read-only operations straight away, and after
239 visiting the 'Login' page to authenticate, perform other operations like
240 adding a track to the queue.
242 4. If you run into problems, always look at the appropriate error log; the
243 message you see in your web browser will usually not be sufficient to
244 diagnose the problem all by itself.
246 5. If you have a huge number of top level directories, then you might find
247 that the 'Choose' page is unreasonably large. If so add the following line
248 to /etc/disorder/options.user:
249 label sidebar.choosewhich choosealpha
251 This will make 'Choose' be a link for each letter of the 26-letter Roman
252 alphabet; follow the link and you just get the directories which start with
253 that letter. The "*" link at the end gives you directories which don't
256 You can copy choosealpha.html to /etc/disorder and edit it to change the
257 set of initial choices to anything that can be expressed with regexps. The
258 regexps must be URL-encoded UTF-8 PCRE regexps.
260 If you want to give DisOrder its own virtual host, see README.vhost.
265 "Nothing but another drug, a licence that you buy and sell"
267 DisOrder - select and play digital audio files
268 Copyright (C) 2003-2009 Richard Kettlewell
269 Portions copyright (C) 2007 Ross Younger
270 Portions copyright (C) 2007 Mark Wooding
271 Portions extracted from MPG321, http://mpg321.sourceforge.net/
272 Copyright (C) 2001 Joe Drew
273 Copyright (C) 2000-2001 Robert Leslie
274 Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
275 Portions Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
276 Binaries may derive extra copyright owners through linkage (binary distributors
277 are expected to do their own legwork)
279 This program is free software: you can redistribute it and/or modify
280 it under the terms of the GNU General Public License as published by
281 the Free Software Foundation, either version 3 of the License, or
282 (at your option) any later version.
284 This program is distributed in the hope that it will be useful,
285 but WITHOUT ANY WARRANTY; without even the implied warranty of
286 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
287 GNU General Public License for more details.
289 You should have received a copy of the GNU General Public License
290 along with this program. If not, see <http://www.gnu.org/licenses/>.