chiark / gitweb /
automatically create the home directory on startup
[disorder] / README
1 DisOrder
2 ========
3
4 This program is used to play random and chosen tracks from a collection of
5 digital audio files (for instance MP3 and OGG files).  If you just set it going
6 it plays random tracks from your collection, but you can also ask for specific
7 tracks to be played, either via a command line program or a web interface, and
8 you can 'scratch' the current track.
9
10 See CHANGES for details of recent changes to DisOrder.
11
12 Currently it only runs on Linux.  It could probably be ported to other UNIX
13 variants in some cases without too much effort.  Things you will need:
14
15 Build dependencies:
16   Name             Tested              Notes
17   libdb            4.3.29              4.2 and earlier won't work
18   libgc            6.8
19   libvorbisfile    1.1.2
20   libpcre          6.7                 need UTF-8 support
21   libmad           0.15.1b
22   libgcrypt        1.2.3
23   libao            0.8.6
24   libasound        1.0.13
25   libFLAC          1.1.2
26   GNU C            4.1.2
27   GNU Make         3.81
28   Python           2.4.4               (optional)
29   GTK+             2.8.20              (if you want the GTK+ client)
30   GLIB             2.12.4              (if you want the GTK+ client)
31
32 "Tested" means I've built against that version; earlier or later versions will
33 often work too.
34
35 Runtime dependencies:
36  * Web server:
37    + Apache 1.3.x works for me, but anything that supports CGI and
38      authentication should be suitable.
39  * Separate player programs are no longer required (but may still be used)
40
41 Development dependencies (only developers will need these):
42   Automake         1.10                AM_PATH_PYTHON not good enough in 1.7
43   Autoconf         2.61
44   Libtool          1.5.22              1.4 not good enough
45   Bazaar (bzr)
46
47 On Debian you might ensure you have the required packages as follows:
48   apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
49                   libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
50                   libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
51                   libflac-dev
52
53 Mailing lists:
54   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
55    - discussion of DisOrder (and other software), bug reports, etc
56   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
57    - announcements of new versions of DisOrder
58
59
60 Installation
61 ============
62
63    "This place'd be a paradise tomorrow, if every department had a supervisor
64    with a machine-gun"
65
66 NOTE: If you are upgrading from an earlier version, see README.upgrades.
67
68 1. Build the software.  Do something like this:
69
70      ./configure --sysconfdir=/etc --localstatedir=/var
71      make
72
73    See INSTALL for more details about driving configure.  The precise set of
74    options you pass to configure is up to you, if you like configuration being
75    in /usr/local/etc or wherever then that should work.
76
77    If you only want to build a subset of DisOrder, specify one or more of the
78    following options:
79      --without-server       Don't build server or web interface
80      --without-gtk          Don't build GTK+ client (Disobedience)
81      --without-python       Don't build Python support
82
83    See README.client for setting up a standalone client (or read the
84    disobedience man page).
85
86    The server is only built by default under Linux.  See README.mac concerning
87    its use under OS X.
88
89 2. Install it.  Most of the installation is done via the install target:
90
91      make installdirs install
92
93    The CGI interface has to be installed separately:
94
95      install -m 755 clients/disorder.cgi /usr/local/lib/cgi-bin/disorder
96
97 3. Create a 'jukebox' user and group, with the jukebox group being the default
98    group of the jukebox user.  The server will run as this user and group.
99    Check that this user can read your music files and write to the audio
100    device, e.g. by playing a track.  The exact name doesn't matter, it could be
101    'jukebox' or 'disorder' or 'fred' or whatever.
102
103    Do not use a general-purpose user or group, you must create ones
104    specifically for DisOrder.
105
106 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it
107    to your own requirements.  In particular, you should:
108     * add 'player' commands for any file formats not supported natively
109     * edit the 'collection' command to identify the location(s) of your own
110       digital audio files.  These commands also specify the encoding of
111       filenames, which you should be sure to get right as recovery from an
112       error here can be painful (see BUGS).
113     * edit the 'scratch' commands to supply scratch sounds (or delete them if
114       you don't want any).
115     * edit the 'trust' command to reflect the user the web interface will
116       eventually run as.
117     * edit the 'url' command to give the URL of the web interface.
118     * add or remove 'stopword' entries as necessary (these words won't take
119       part in track name searches from the web interface).
120
121    See disorder_config(5) for more details.
122
123    See README.raw for details on setting up "raw format" players, which allow
124    for pausing and gapless play.
125
126 5. Create /etc/disorder/config.private.  This should be readable only by the
127    jukebox group:
128
129      touch /etc/disorder/config.private
130      chown root:jukebox /etc/disorder/config.private
131      chmod 640 /etc/disorder/config.private
132
133    Set up a username and password for root, for example with line like this:
134
135      allow root somepassword
136
137    Use (for instance) pwgen(1) to create the password.  DO NOT use your root
138    password - this is a password to give root access to the server, not to give
139    access to the root login.
140
141    See disorderd(8) and disorder_config(5) for more details.
142
143 6. Make sure the server is started at boot time.
144
145    On many Linux systems, examples/disorder.init should be more or less
146    suitable; install it in /etc/init.d, adapting it as necessary, and make
147    appropriate links from /etc/rc[0-6].d.
148
149 7. Start the server.
150
151    On Linux systems with sysv-style init:
152
153      /etc/init.d/disorder start
154
155    By default disorderd logs to daemon.*; check your syslog.conf to see where
156    this ends up and look for log messages from disorderd there.  If it didn't
157    start up correctly there should be an error message.  Correct the problem
158    and try again.
159
160 8. After a minute it should start to play something.  Try scratching it, as any
161    of the users you set up in step 5:
162
163      disorder scratch
164
165    The track should stop playing, and (if you set any up) a scratch sound play.
166
167 9. Add any other users you want to config.private.  Each user's password
168    should be stored in a file in their home directory, ~/.disorder/passwd,
169    which should be readable only by them, and should take the form of a single
170    line:
171
172      password MYPASSWORD
173
174    (root doesn't need this as the client can read it out of config.private
175    when running as root.)
176
177    Note that the server must be reloaded (e.g. by 'disorder reconfigure')
178    when new users are added.
179
180    Alternatively the administrator can create /etc/disorder/config.USERNAME
181    containing the same thing as above.  It can either be owned by the user and
182    mode 400, or owned by root and the user's group (if you have per-user
183    groups) and mode 440.
184
185    You can use 'disorder authorize' to automatically pick passwords and
186    create these files.
187
188 10. Optionally source completion.bash from /etc/profile or similar, for
189     example:
190
191       . /usr/local/share/disorder/completion.bash
192
193     This provides completion over disorder command and option names.
194
195
196 Web Interface
197 =============
198
199    "Thought I was a gonner baby, but I'm bullet proof"
200
201 These instructions assumes you are using Apache 1.3.x.
202
203 You need to configure a number of things to make this work:
204
205 1. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
206    if you are somehow reading this in the 1980s) accordingly and use a fragment
207    such as this one:
208
209      <VirtualHost HOSTNAME>
210      DocumentRoot /home/jukebox/public_html
211      ServerName jukebox.DOMAIN
212      ServerAlias jukebox
213      ServerAdmin webmaster@DOMAIN
214      ErrorLog /var/log/apache/jukebox/error.log
215      TransferLog /var/log/apache/jukebox/access.log
216      Alias /static/ /usr/local/share/disorder/static/
217      </VirtualHost>
218
219    /static/ should point to the 'static' directory installed by DisOrder.  If
220    you don't want to use the name 'static' then you can change the url.static
221    label in the web interface configuration to your preferred URL; see
222    disorder_config(5) for details.
223
224    Don't forget to reload Apache after modifying its configuration.
225
226    Separate logging is not required but I find it convenient.  Up to you.
227
228 2. disorder.cgi assumes it is subject to access control (and in particular uses
229    the username to report who did what).  Here's how I configured Apache, given
230    the above VirtualHost settings:
231
232      <Directory /home/jukebox>
233      Require valid-user
234      AuthType basic
235      AuthName jukebox
236      AuthUserFile /home/jukebox/http.users
237      </Directory>
238
239    Adjust this according to wherever you're going to install disorder.cgi and
240    its expected URL.
241
242    Don't forget to reload apache after modifying its configuration.  If you got
243    it wrong, fix it and restart Apache.
244
245 3. Create the password file configured above.  Something like this:
246
247      # htpasswd -b -c /home/jukebox/http.users myusername mypassword
248      Adding password for user myusername
249      # htpasswd -b /home/jukebox/http.users othername otherpass
250      Adding password for user othername
251
252 4. The jukebox must be configured to trust the web user.  I added the following
253    line to my /etc/disorder/config:
254
255      trust www-data
256
257    This might not be the same on your system!  You have to specify the user
258    that the CGI script runs as, whatever that is.
259
260 5. Install disorder.cgi in an appropriate location.  Remember to make it
261    executable.  With the above configuration I installed it as
262    ~jukebox/public_html/index.cgi.
263
264 6. Give www-data (or whatever user it is) a password and edit
265    /etc/disorder/config.private accordingly.  This file should be mode 640 and
266    owned by root:jukebox.  The line should look something like this:
267
268      allow www-data MYPASSWORD
269
270    After editing the config file, you must make the daemon re-read it:
271
272      disorder reconfigure
273
274 7. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
275    This file should be mode 640 and owned by root:www-data.
276
277      password MYPASSWORD
278
279    (You could also use ~www-data/.disorder/passwd for this but on some systems
280    the web server user's home directory is inside the document root, which
281    would have rather unfortunate consequences.)
282
283 8. Try it out.  You should be asked for a username and password that you
284    configured earlier, and be shown details of what is playing and what other
285    tracks have been configured for future play.
286
287 9. Some features take time to start working, for instance those involving
288    reporting the length of tracks.  This is because the server starts up as
289    quickly as possible even if the full track data has not yet been gathered;
290    the track data is then calculated in the background.
291
292 10. If you run into problems, always look at the appropriate error log; the
293     message you see in your web browser will usually not be sufficient to
294     diagnose the problem all by itself.
295
296 11. If you have a huge number of top level directories, then you might find
297     that the 'Choose' page is unreasonably large.  If so add the following line
298     to /etc/disorder/options.user:
299       label sidebar.choosewhich choosealpha
300
301     This will make 'Choose' be a link for each letter of the 26-letter Roman
302     alphabet; follow the link and you just get the directories which start with
303     that letter.  The "*" link at the end gives you directories which don't
304     start with a letter.
305
306     You can copy choosealpha.html to /etc/disorder and edit it to change the
307     set of initial choices to anything that can be expressed with regexps.  The
308     regexps must be URL-encoded UTF-8 PCRE regexps.
309
310
311 Copyright
312 =========
313
314   "Nothing but another drug, a licence that you buy and sell"
315
316 DisOrder - select and play digital audio files
317 Copyright (C) 2003-2007 Richard Kettlewell
318 Portions extracted from MPG321, http://mpg321.sourceforge.net/
319   Copyright (C) 2001 Joe Drew
320   Copyright (C) 2000-2001 Robert Leslie
321 Binaries may derive extra copyright owners through linkage (binary distributors
322 are expected to do their own legwork)
323
324 This program is free software; you can redistribute it and/or modify it under
325 the terms of the GNU General Public License as published by the Free Software
326 Foundation; either version 2 of the License, or (at your option) any later
327 version.
328
329 This program is distributed in the hope that it will be useful, but WITHOUT ANY
330 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
331 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
332
333 You should have received a copy of the GNU General Public License along with
334 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
335 Place, Suite 330, Boston, MA 02111-1307 USA
336
337 Local Variables:
338 mode:text
339 fill-column:79
340 End: