chiark / gitweb /
Catch up with new CGI location
[disorder] / README
1 DisOrder
2 ========
3
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
11      word or tag 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").
15
16 See CHANGES for details of recent changes to DisOrder and README.upgrades for
17 upgrade instructions.
18
19 Platform 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
23 It could probably be ported to some other UNIX variants without too much
24 effort.
25
26 Build dependencies:
27   Name             Tested              Notes
28   libdb            4.3.29              not 4.2.x; 4.4+ might work.
29   libgc            6.8
30   libvorbisfile    1.1.2
31   libpcre          6.7                 need UTF-8 support
32   libmad           0.15.1b
33   libgcrypt        1.2.3
34   libao            0.8.6
35   libasound        1.0.13
36   libFLAC          1.1.2
37   GNU C            4.1.2
38   GNU Make         3.81
39   GNU Sed          4.1.5
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)
43
44 "Tested" means I've built against that version; earlier or later versions will
45 often work too.
46
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
49 OK.
50
51 Bug tracker, etc:
52   http://code.google.com/p/disorder/
53
54 Mailing 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
60 Developers should read README.developers.
61
62
63 Installation
64 ============
65
66    "This place'd be a paradise tomorrow, if every department had a supervisor
67    with a machine-gun"
68
69 IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
70
71 Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
72 files.
73
74 OX 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
76 platform, please get in touch.
77
78 1. Build the software.  Do something like this:
79
80      ./configure
81      make                   # on FreeBSD use gmake
82
83    See INSTALL or ./configure --help for more details about driving configure.
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
91    See README.client for setting up a standalone client (or read the
92    disobedience man page).
93
94    To build .debs on Debian/Ubuntu, use:
95      fakeroot debian/rules binary
96
97 2. Install it.  Most of the installation is done via the install target:
98
99      make installdirs install
100
101    The CGI interface has to be installed separately; see under 'Web Interface'
102    below.
103
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
107 3. 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
116 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it
117    to your own requirements.  The things you MUST do are:
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).
122    Optionally you may also want to do the following:
123     * add 'player' and 'tracklength' commands for any file formats not
124       supported natively
125     * edit the 'scratch' commands to supply scratch sounds (or delete them if
126       you don't want any).
127     * add extra 'stopword' entries as necessary (these words won't take part in
128       track name searches from the web interface).
129
130    See disorder_config(5) for more details.
131
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
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.
139
140 5. Make sure the server is started at boot time.
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
146 6. Start the server.
147
148    On Linux systems with sysv-style init:
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
157 7. After a short while it should start to play something.  Try scratching it
158    (as root):
159
160      disorder scratch
161
162    The track should stop playing, and (if you set any up) a scratch sound play.
163
164 8. Add any other users you want.  These easiest way to do this is (still as
165    root):
166
167      disorder authorize USERNAME
168
169    This will automatically choose a random password and create
170    ~USERNAME/.disorder/passwd.
171
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
177    Alternatively, after setting up the web interface (below), it's possible to
178    allow users to register themselves without operator involvement.
179
180 9. Optionally source completion.bash from /etc/profile or similar, for
181    example:
182
183      . /usr/local/share/disorder/completion.bash
184
185    This provides completion over disorder command and option names.
186
187
188 Web Interface
189 =============
190
191    "Thought I was a gonner baby, but I'm bullet proof"
192
193 Debian/Ubuntu: the .deb files will do the setup here automatically.
194
195 OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
196 here automatically.
197
198 You need to configure a number of things to make this work:
199
200 1. If you want online registration to work then set mail_sender in
201    /etc/disorder/config to the email address that communications from the web
202    interface will appear to be sent.  If this is not a valid, deliverable email
203    address then the results are not likely to be reliable.
204
205      mail_sender webmaster@example.com
206
207    By default the web interface sends mail by connecting to the SMTP port of
208    127.0.0.1.  You can override this with the smtp_server directive, for
209    exampler:
210
211      smtp_server mail.example.com
212
213    Use 'disorder reconfigure' to make sure the server knows these settings.
214
215 2. The web interface depends on a 'guest' user existing.  You can create this
216    with the following command:
217
218      disorder setup-guest
219
220    If you don't want to allow online registration instead use:
221
222      disorder setup-guest --no-online-registration
223
224 3. Make sure that DisOrder can find its icons and stylesheet.  For example in
225    your web server configuration:
226
227      Alias /disorder/ /usr/local/share/disorder/static/
228
229    Alternatively you could use a symlink from the right location in your
230    document root, provided your web server is configured to follow them.
231
232      cd /var/www
233      ln -s /usr/local/share/disorder/static disorder
234
235 4. Install disorder.cgi in an appropriate location.  Remember to make it
236    executable.  Example:
237
238      install -m 755 cgi/disorder.cgi /usr/lib/cgi-bin/disorder
239
240 5. Try it out.  You should be able to perform read-only operations straight
241    away, and after visiting the 'Login' page to authenticate, perform other
242    operations like adding a track to the queue.
243
244 6. If you run into problems, always look at the appropriate error log; the
245    message you see in your web browser will usually not be sufficient to
246    diagnose the problem all by itself.
247
248 7. If you have a huge number of top level directories, then you might find
249    that the 'Choose' page is unreasonably large.  If so add the following line
250    to /etc/disorder/options.user:
251      label sidebar.choosewhich choosealpha
252
253    This will make 'Choose' be a link for each letter of the 26-letter Roman
254    alphabet; follow the link and you just get the directories which start with
255    that letter.  The "*" link at the end gives you directories which don't
256    start with a letter.
257
258    You can copy choosealpha.html to /etc/disorder and edit it to change the
259    set of initial choices to anything that can be expressed with regexps.  The
260    regexps must be URL-encoded UTF-8 PCRE regexps.
261
262 If you want to give DisOrder its own virtual host, see README.vhost.
263
264 Copyright
265 =========
266
267   "Nothing but another drug, a licence that you buy and sell"
268
269 DisOrder - select and play digital audio files
270 Copyright (C) 2003-2008 Richard Kettlewell
271 Portions copyright (C) 2007 Ross Younger
272 Portions copyright (C) 2007 Mark Wooding
273 Portions extracted from MPG321, http://mpg321.sourceforge.net/
274   Copyright (C) 2001 Joe Drew
275   Copyright (C) 2000-2001 Robert Leslie
276 Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
277 Binaries may derive extra copyright owners through linkage (binary distributors
278 are expected to do their own legwork)
279
280 This program is free software; you can redistribute it and/or modify it under
281 the terms of the GNU General Public License as published by the Free Software
282 Foundation; either version 2 of the License, or (at your option) any later
283 version.
284
285 This program is distributed in the hope that it will be useful, but WITHOUT ANY
286 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
287 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
288
289 You should have received a copy of the GNU General Public License along with
290 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
291 Place, Suite 330, Boston, MA 02111-1307 USA
292
293 Local Variables:
294 mode:text
295 fill-column:79
296 End: