chiark / gitweb /
tart up README some more
[disorder] / README
460b9539 1DisOrder
4DisOrder 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
11 word search.
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").
460b9539 15
16See CHANGES for details of recent changes to DisOrder.
18The server supports Linux and can be made to on a Mac. The clients work on
19both Linux and the Mac. It could probably be ported to some other UNIX
20variants in without too much effort. Things you will need:
460b9539 21
22Build dependencies:
23 Name Tested Notes
1a0d3568 24 libdb 4.3.29 4.2 and earlier won't work
25 libgc 6.8
26 libvorbisfile 1.1.2
27 libpcre 6.7 need UTF-8 support
460b9539 28 libmad 0.15.1b
1a0d3568 29 libgcrypt 1.2.3
460b9539 30 libao 0.8.6
1a0d3568 31 libasound 1.0.13
32 libFLAC 1.1.2
33 GNU C 4.1.2
34 GNU Make 3.81
35 Python 2.4.4 (optional)
36 GTK+ 2.8.20 (if you want the GTK+ client)
37 GLIB 2.12.4 (if you want the GTK+ client)
460b9539 38
39"Tested" means I've built against that version; earlier or later versions will
40often work too.
42Runtime dependencies:
460b9539 43 * Web server:
44 + Apache 1.3.x works for me, but anything that supports CGI and
45 authentication should be suitable.
1a0d3568 46 * Separate player programs are no longer required (but may still be used)
460b9539 47
48Development dependencies (only developers will need these):
1a0d3568 49 Automake 1.10 AM_PATH_PYTHON not good enough in 1.7
50 Autoconf 2.61
51 Libtool 1.5.22 1.4 not good enough
39068fb4 52 Bazaar (bzr)
460b9539 53
e9194ec6 54On Debian you might ensure you have the required packages as follows:
55 apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
56 libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
1a0d3568 57 libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
58 libflac-dev
e9194ec6 59
460b9539 60Mailing lists:
62 - discussion of DisOrder (and other software), bug reports, etc
64 - announcements of new versions of DisOrder
70 "This place'd be a paradise tomorrow, if every department had a supervisor
71 with a machine-gun"
73NOTE: If you are upgrading from an earlier version, see README.upgrades.
751. Build the software. Do something like this:
77 ./configure --sysconfdir=/etc --localstatedir=/var
78 make
80 See INSTALL for more details about driving configure. The precise set of
81 options you pass to configure is up to you, if you like configuration being
82 in /usr/local/etc or wherever then that should work.
84 If you only want to build a subset of DisOrder, specify one or more of the
85 following options:
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 The server is only built by default under Linux. See README.mac concerning
94 its use under OS X.
460b9539 95
962. Install it. Most of the installation is done via the install target:
98 make installdirs install
655cae67 100 The CGI interface has to be installed separately:
460b9539 101
655cae67 102 install -m 755 clients/disorder.cgi /usr/local/lib/cgi-bin/disorder
460b9539 103
460b9539 1043. Create a 'jukebox' user and group, with the jukebox group being the default
105 group of the jukebox user. The server will run as this user and group.
106 Check that this user can read your music files and write to the audio
107 device, e.g. by playing a track. The exact name doesn't matter, it could be
108 'jukebox' or 'disorder' or 'fred' or whatever.
110 Do not use a general-purpose user or group, you must create ones
111 specifically for DisOrder.
1134. Create /etc/disorder/config. Start from examples/config.sample and adapt it
114 to your own requirements. In particular, you should:
75db8354 115 * add 'player' commands for any file formats not supported natively
460b9539 116 * edit the 'collection' command to identify the location(s) of your own
117 digital audio files. These commands also specify the encoding of
118 filenames, which you should be sure to get right as recovery from an
119 error here can be painful (see BUGS).
120 * edit the 'scratch' commands to supply scratch sounds (or delete them if
121 you don't want any).
122 * edit the 'trust' command to reflect the user the web interface will
123 eventually run as.
124 * edit the 'url' command to give the URL of the web interface.
125 * add or remove 'stopword' entries as necessary (these words won't take
126 part in track name searches from the web interface).
128 See disorder_config(5) for more details.
130 See README.raw for details on setting up "raw format" players, which allow
131 for pausing and gapless play.
36be7e6a 1335. Make sure the server is started at boot time.
135 On many Linux systems, examples/disorder.init should be more or less
136 suitable; install it in /etc/init.d, adapting it as necessary, and make
137 appropriate links from /etc/rc[0-6].d.
36be7e6a 1396. Start the server.
141 On Linux systems with sysv-style init:
460b9539 142
143 /etc/init.d/disorder start
145 By default disorderd logs to daemon.*; check your syslog.conf to see where
146 this ends up and look for log messages from disorderd there. If it didn't
147 start up correctly there should be an error message. Correct the problem
148 and try again.
9025afab 1507. After a minute it should start to play something. Try scratching it:
460b9539 151
152 disorder scratch
154 The track should stop playing, and (if you set any up) a scratch sound play.
8ae47ac8 1568. Add any other users you want. These easiest way to do this is:
460b9539 157
8ae47ac8 158 disorder authorize USERNAME
460b9539 159
160 This will automatically choose a random password and add new line to
161 /etc/disorder/config.private and create /etc/disorder/config.USERNAME.
460b9539 162
163 Those users should now be able to access the server from the same host as it
164 runs on, either via the disorder command or Disobedience. To run
165 Disobedience from some other host, File->Login allows hostnames, passwords
166 etc to be configured.
1689. Optionally source completion.bash from /etc/profile or similar, for
169 example:
460b9539 170
36be7e6a 171 . /usr/local/share/disorder/completion.bash
460b9539 172
36be7e6a 173 This provides completion over disorder command and option names.
460b9539 174
176Web Interface
179 "Thought I was a gonner baby, but I'm bullet proof"
181These instructions assumes you are using Apache 1.3.x.
183You need to configure a number of things to make this work:
1851. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
186 if you are somehow reading this in the 1980s) accordingly and use a fragment
187 such as this one:
189 <VirtualHost HOSTNAME>
190 DocumentRoot /home/jukebox/public_html
191 ServerName jukebox.DOMAIN
192 ServerAlias jukebox
193 ServerAdmin webmaster@DOMAIN
194 ErrorLog /var/log/apache/jukebox/error.log
195 TransferLog /var/log/apache/jukebox/access.log
196 Alias /static/ /usr/local/share/disorder/static/
197 </VirtualHost>
199 /static/ should point to the 'static' directory installed by DisOrder. If
200 you don't want to use the name 'static' then you can change the url.static
201 label in the web interface configuration to your preferred URL; see
202 disorder_config(5) for details.
204 Don't forget to reload Apache after modifying its configuration.
206 Separate logging is not required but I find it convenient. Up to you.
2082. disorder.cgi assumes it is subject to access control (and in particular uses
209 the username to report who did what). Here's how I configured Apache, given
210 the above VirtualHost settings:
212 <Directory /home/jukebox>
213 Require valid-user
214 AuthType basic
215 AuthName jukebox
216 AuthUserFile /home/jukebox/http.users
217 </Directory>
219 Adjust this according to wherever you're going to install disorder.cgi and
220 its expected URL.
222 Don't forget to reload apache after modifying its configuration. If you got
223 it wrong, fix it and restart Apache.
2253. Create the password file configured above. Something like this:
227 # htpasswd -b -c /home/jukebox/http.users myusername mypassword
228 Adding password for user myusername
229 # htpasswd -b /home/jukebox/http.users othername otherpass
230 Adding password for user othername
2324. The jukebox must be configured to trust the web user. I added the following
233 line to my /etc/disorder/config:
235 trust www-data
237 This might not be the same on your system! You have to specify the user
238 that the CGI script runs as, whatever that is.
2405. Install disorder.cgi in an appropriate location. Remember to make it
241 executable. With the above configuration I installed it as
242 ~jukebox/public_html/index.cgi.
2446. Give www-data (or whatever user it is) a password and edit
245 /etc/disorder/config.private accordingly. This file should be mode 640 and
246 owned by root:jukebox. The line should look something like this:
248 allow www-data MYPASSWORD
250 After editing the config file, you must make the daemon re-read it:
252 disorder reconfigure
2547. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
255 This file should be mode 640 and owned by root:www-data.
257 password MYPASSWORD
259 (You could also use ~www-data/.disorder/passwd for this but on some systems
260 the web server user's home directory is inside the document root, which
261 would have rather unfortunate consequences.)
2638. Try it out. You should be asked for a username and password that you
264 configured earlier, and be shown details of what is playing and what other
265 tracks have been configured for future play.
2679. Some features take time to start working, for instance those involving
268 reporting the length of tracks. This is because the server starts up as
269 quickly as possible even if the full track data has not yet been gathered;
270 the track data is then calculated in the background.
27210. If you run into problems, always look at the appropriate error log; the
273 message you see in your web browser will usually not be sufficient to
274 diagnose the problem all by itself.
27611. If you have a huge number of top level directories, then you might find
277 that the 'Choose' page is unreasonably large. If so add the following line
278 to /etc/disorder/options.user:
279 label sidebar.choosewhich choosealpha
281 This will make 'Choose' be a link for each letter of the 26-letter Roman
282 alphabet; follow the link and you just get the directories which start with
283 that letter. The "*" link at the end gives you directories which don't
284 start with a letter.
286 You can copy choosealpha.html to /etc/disorder and edit it to change the
287 set of initial choices to anything that can be expressed with regexps. The
288 regexps must be URL-encoded UTF-8 PCRE regexps.
294 "Nothing but another drug, a licence that you buy and sell"
296DisOrder - select and play digital audio files
eb525fcd 297Copyright (C) 2003-2007 Richard Kettlewell
460b9539 298Portions extracted from MPG321,
299 Copyright (C) 2001 Joe Drew
300 Copyright (C) 2000-2001 Robert Leslie
301Binaries may derive extra copyright owners through linkage (binary distributors
302are expected to do their own legwork)
304This program is free software; you can redistribute it and/or modify it under
305the terms of the GNU General Public License as published by the Free Software
306Foundation; either version 2 of the License, or (at your option) any later
309This program is distributed in the hope that it will be useful, but WITHOUT ANY
310WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
311PARTICULAR PURPOSE. See the GNU General Public License for more details.
313You should have received a copy of the GNU General Public License along with
314this program; if not, write to the Free Software Foundation, Inc., 59 Temple
315Place, Suite 330, Boston, MA 02111-1307 USA
317Local Variables: