chiark / gitweb /
remove css cruft for long-gone separate search page
[disorder] / README
CommitLineData
460b9539 1DisOrder
2========
3
9025afab
RK
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
5b14453f 11 word or tag search.
9025afab
RK
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
b0a578cb
RK
16See CHANGES.html for details of recent changes to DisOrder and README.upgrades
17for upgrade instructions.
460b9539 18
7a4c02b0
RK
19Platform support:
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
23It could probably be ported to some other UNIX variants without too much
24effort.
460b9539 25
26Build dependencies:
27 Name Tested Notes
662886f6 28 libdb 4.3.29 not 4.2.x; 4.4+ might work.
1a0d3568 29 libgc 6.8
30 libvorbisfile 1.1.2
31 libpcre 6.7 need UTF-8 support
460b9539 32 libmad 0.15.1b
1a0d3568 33 libgcrypt 1.2.3
460b9539 34 libao 0.8.6
1a0d3568 35 libasound 1.0.13
36 libFLAC 1.1.2
37 GNU C 4.1.2
38 GNU Make 3.81
ddf922de 39 GNU Sed 4.1.5
1a0d3568 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)
460b9539 43
44"Tested" means I've built against that version; earlier or later versions will
45often work too.
46
91d9a42d 47For the web interface to work you will additionally need a web server. I've
48had both Apache 1.3.x and 2.x working. Anything that supports CGI should be
49OK.
e9194ec6 50
802cbf55
RK
51Bug tracker, etc:
52 http://code.google.com/p/disorder/
53
460b9539 54Mailing lists:
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
59
91d9a42d 60Developers should read README.developers.
61
460b9539 62
7a4c02b0
RK
63Installation
64============
460b9539 65
66 "This place'd be a paradise tomorrow, if every department had a supervisor
67 with a machine-gun"
68
5b14453f 69IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
460b9539 70
7a4c02b0
RK
71Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
72files.
73
f3e157f7
RK
74OX X/FreeBSD/other Linux: after installation (step 1 and 2), running
75'sudo bash scripts/setup' will cover steps 3 to 6. If it doesn't work on your
76platform, please get in touch.
7a4c02b0 77
460b9539 781. Build the software. Do something like this:
79
7a4c02b0
RK
80 ./configure
81 make # on FreeBSD use gmake
460b9539 82
7a4c02b0 83 See INSTALL or ./configure --help for more details about driving configure.
460b9539 84
85 If you only want to build a subset of DisOrder, specify one or more of the
86 following options:
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
90
655cae67
RK
91 See README.client for setting up a standalone client (or read the
92 disobedience man page).
93
7a4c02b0
RK
94 To build .debs on Debian/Ubuntu, use:
95 fakeroot debian/rules binary
96
460b9539 972. Install it. Most of the installation is done via the install target:
98
99 make installdirs install
100
813070ec
RK
101 The CGI interface has to be installed separately; see under 'Web Interface'
102 below.
460b9539 103
7a4c02b0
RK
104 NB steps 3 to 6 are covered by scripts/setup. It should work on FreeBSD, OS
105 X and Linux and could be adapted to other platforms.
106
460b9539 1073. Create a 'jukebox' user and group, with the jukebox group being the default
108 group of the jukebox user. The server will run as this user and group.
109 Check that this user can read your music files and write to the audio
110 device, e.g. by playing a track. The exact name doesn't matter, it could be
111 'jukebox' or 'disorder' or 'fred' or whatever.
112
113 Do not use a general-purpose user or group, you must create ones
114 specifically for DisOrder.
115
1164. Create /etc/disorder/config. Start from examples/config.sample and adapt it
be2d9f37 117 to your own requirements. The things you MUST do are:
460b9539 118 * edit the 'collection' command to identify the location(s) of your own
119 digital audio files. These commands also specify the encoding of
120 filenames, which you should be sure to get right as recovery from an
121 error here can be painful (see BUGS).
be2d9f37 122 Optionally you may also want to do the following:
e6a35d1c
RK
123 * add 'player' and 'tracklength' commands for any file formats not
124 supported natively
460b9539 125 * edit the 'scratch' commands to supply scratch sounds (or delete them if
126 you don't want any).
e6a35d1c
RK
127 * add extra 'stopword' entries as necessary (these words won't take part in
128 track name searches from the web interface).
460b9539 129
130 See disorder_config(5) for more details.
131
da6f7693
RK
132 See README.streams for how to set up network play.
133
134 If adding new 'player' commands, see README.raw for details on setting up
135 "raw format" players. Non-raw players are still supported but not in all
662886f6 136 configurations and they cannot support pausing and gapless play. If you
137 want additional formats to be supported natively please point the author at
138 a GPL-compatible library that can decode them.
6e2c9f5f 139
36be7e6a 1405. Make sure the server is started at boot time.
e83d0967
RK
141
142 On many Linux systems, examples/disorder.init should be more or less
143 suitable; install it in /etc/init.d, adapting it as necessary, and make
144 appropriate links from /etc/rc[0-6].d.
145
36be7e6a 1466. Start the server.
e83d0967
RK
147
148 On Linux systems with sysv-style init:
460b9539 149
150 /etc/init.d/disorder start
151
152 By default disorderd logs to daemon.*; check your syslog.conf to see where
153 this ends up and look for log messages from disorderd there. If it didn't
154 start up correctly there should be an error message. Correct the problem
155 and try again.
156
01f400ed
RK
1577. After a short while it should start to play something. Try scratching it
158 (as root):
460b9539 159
160 disorder scratch
161
162 The track should stop playing, and (if you set any up) a scratch sound play.
163
5f5fc693
RK
1648. Add any other users you want. These easiest way to do this is (still as
165 root):
460b9539 166
8ae47ac8 167 disorder authorize USERNAME
460b9539 168
f0feb22e 169 This will automatically choose a random password and create
5b14453f 170 ~USERNAME/.disorder/passwd.
460b9539 171
9025afab
RK
172 Those users should now be able to access the server from the same host as it
173 runs on, either via the disorder command or Disobedience. To run
174 Disobedience from some other host, File->Login allows hostnames, passwords
175 etc to be configured.
176
7a4c02b0
RK
177 Alternatively, after setting up the web interface (below), it's possible to
178 allow users to register themselves without operator involvement.
179
36be7e6a
RK
1809. Optionally source completion.bash from /etc/profile or similar, for
181 example:
460b9539 182
36be7e6a 183 . /usr/local/share/disorder/completion.bash
460b9539 184
36be7e6a 185 This provides completion over disorder command and option names.
460b9539 186
187
188Web Interface
189=============
190
191 "Thought I was a gonner baby, but I'm bullet proof"
192
7a4c02b0
RK
193Debian/Ubuntu: the .deb files will do the setup here automatically.
194
195OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
196here automatically.
460b9539 197
198You need to configure a number of things to make this work:
199
662886f6 2001. If you want online registration to work then set mail_sender in
e70701e7 201 /etc/disorder/config to the email address that communications from the web
563071c2 202 interface will appear to be sent. If this is not a valid, deliverable email
662886f6 203 address then the results are not likely to be reliable.
e70701e7 204
205 mail_sender webmaster@example.com
206
2eee4b0c
RK
207 By default the web interface sends mail via the system sendmail executable
208 (typically /usr/sbin/sendmail or /usr/lib/sendmail). You can override this
209 with the sendmail directive, for example:
210
211 sendmail /usr/sbin/my-sendmail
212
213 The executable you choose must support the -bs option. Alternatively you
214 can tell it to connect to an SMTP server via TCP, with the smtp_server
215 directive. For example:
e70701e7 216
217 smtp_server mail.example.com
218
ad884aa5 219 Use 'disorder reconfigure' to make sure the server knows these settings.
220
e70701e7 2212. The web interface depends on a 'guest' user existing. You can create this
5e34540b 222 with the following command:
223
224 disorder setup-guest
225
226 If you don't want to allow online registration instead use:
227
a767291c 228 disorder setup-guest --no-online-registration
5e34540b 229
a767291c 2303. Make sure that DisOrder can find its icons and stylesheet. For example in
231 your web server configuration:
460b9539 232
5e34540b 233 Alias /disorder/ /usr/local/share/disorder/static/
460b9539 234
5e34540b 235 Alternatively you could use a symlink from the right location in your
236 document root, provided your web server is configured to follow them.
237
a767291c 238 cd /var/www
239 ln -s /usr/local/share/disorder/static disorder
460b9539 240
e70701e7 2414. Install disorder.cgi in an appropriate location. Remember to make it
a767291c 242 executable. Example:
5e34540b 243
3c03f557 244 install -m 755 cgi/disorder.cgi /usr/lib/cgi-bin/disorder
5e34540b 245
e70701e7 2465. Try it out. You should be able to perform read-only operations straight
d84bf422 247 away, and after visiting the 'Login' page to authenticate, perform other
248 operations like adding a track to the queue.
460b9539 249
e70701e7 2506. If you run into problems, always look at the appropriate error log; the
5e34540b 251 message you see in your web browser will usually not be sufficient to
252 diagnose the problem all by itself.
460b9539 253
e70701e7 2547. If you have a huge number of top level directories, then you might find
5e34540b 255 that the 'Choose' page is unreasonably large. If so add the following line
256 to /etc/disorder/options.user:
257 label sidebar.choosewhich choosealpha
258
259 This will make 'Choose' be a link for each letter of the 26-letter Roman
260 alphabet; follow the link and you just get the directories which start with
261 that letter. The "*" link at the end gives you directories which don't
262 start with a letter.
263
264 You can copy choosealpha.html to /etc/disorder and edit it to change the
265 set of initial choices to anything that can be expressed with regexps. The
266 regexps must be URL-encoded UTF-8 PCRE regexps.
460b9539 267
a767291c 268If you want to give DisOrder its own virtual host, see README.vhost.
460b9539 269
270Copyright
271=========
272
273 "Nothing but another drug, a licence that you buy and sell"
274
275DisOrder - select and play digital audio files
8f9616f1 276Copyright (C) 2003-2008 Richard Kettlewell
313acc77
RK
277Portions copyright (C) 2007 Ross Younger
278Portions copyright (C) 2007 Mark Wooding
460b9539 279Portions extracted from MPG321, http://mpg321.sourceforge.net/
280 Copyright (C) 2001 Joe Drew
281 Copyright (C) 2000-2001 Robert Leslie
d436bd52 282Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
460b9539 283Binaries may derive extra copyright owners through linkage (binary distributors
284are expected to do their own legwork)
285
286This program is free software; you can redistribute it and/or modify it under
287the terms of the GNU General Public License as published by the Free Software
288Foundation; either version 2 of the License, or (at your option) any later
289version.
290
291This program is distributed in the hope that it will be useful, but WITHOUT ANY
292WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
293PARTICULAR PURPOSE. See the GNU General Public License for more details.
294
295You should have received a copy of the GNU General Public License along with
296this program; if not, write to the Free Software Foundation, Inc., 59 Temple
297Place, Suite 330, Boston, MA 02111-1307 USA
298
299Local Variables:
300mode:text
301fill-column:79
302End: