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