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