chiark / gitweb /
finish off FLAC support
[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
1a0d3568 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
460b9539 21 libmad 0.15.1b
1a0d3568 22 libgcrypt 1.2.3
460b9539 23 libao 0.8.6
1a0d3568 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)
460b9539 31
32"Tested" means I've built against that version; earlier or later versions will
33often work too.
34
35Runtime dependencies:
460b9539 36 * Web server:
37 + Apache 1.3.x works for me, but anything that supports CGI and
38 authentication should be suitable.
1a0d3568 39 * Separate player programs are no longer required (but may still be used)
460b9539 40
41Development dependencies (only developers will need these):
1a0d3568 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
39068fb4 45 Bazaar (bzr)
460b9539 46
e9194ec6 47On 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 \
1a0d3568 50 libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
51 libflac-dev
e9194ec6 52
460b9539 53Mailing 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
60Installation
61============
62
63 "This place'd be a paradise tomorrow, if every department had a supervisor
64 with a machine-gun"
65
66NOTE: If you are upgrading from an earlier version, see README.upgrades.
67
681. 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.
84
852. Install it. Most of the installation is done via the install target:
86
87 make installdirs install
88
89 The CGI interface has to be installed separately, and you must use Libtool
90 to install it. For instance:
91
92 ./libtool --mode=install install -m 755 progs/disorder.cgi /usr/local/lib/cgi-bin/disorder
93
94 Depending on how your system is configured you may need to link the disorder
95 libao driver into the right directory:
96
97 ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
98
993. Create a 'jukebox' user and group, with the jukebox group being the default
100 group of the jukebox user. The server will run as this user and group.
101 Check that this user can read your music files and write to the audio
102 device, e.g. by playing a track. The exact name doesn't matter, it could be
103 'jukebox' or 'disorder' or 'fred' or whatever.
104
105 Do not use a general-purpose user or group, you must create ones
106 specifically for DisOrder.
107
1084. Create /etc/disorder/config. Start from examples/config.sample and adapt it
109 to your own requirements. In particular, you should:
75db8354 110 * add 'player' commands for any file formats not supported natively
460b9539 111 * edit the 'collection' command to identify the location(s) of your own
112 digital audio files. These commands also specify the encoding of
113 filenames, which you should be sure to get right as recovery from an
114 error here can be painful (see BUGS).
115 * edit the 'scratch' commands to supply scratch sounds (or delete them if
116 you don't want any).
117 * edit the 'trust' command to reflect the user the web interface will
118 eventually run as.
119 * edit the 'url' command to give the URL of the web interface.
120 * add or remove 'stopword' entries as necessary (these words won't take
121 part in track name searches from the web interface).
122
123 See disorder_config(5) for more details.
124
6e2c9f5f
RK
125 See README.raw for details on setting up "raw format" players, which allow
126 for pausing and gapless play.
127
460b9539 1285. Create /etc/disorder/config.private. This should be readable only by the
129 jukebox group:
130
131 touch /etc/disorder/config.private
132 chown root:jukebox /etc/disorder/config.private
133 chmod 640 /etc/disorder/config.private
134
135 Set up a username and password for root, for example with line like this:
136
137 allow root somepassword
138
139 Use (for instance) pwgen(1) to create the password. DO NOT use your root
140 password - this is a password to give root access to the server, not to give
141 access to the root login.
142
143 See disorderd(8) and disorder_config(5) for more details.
144
e83d0967
RK
1456. Make sure the server is started at boot time.
146
147 On many Linux systems, examples/disorder.init should be more or less
148 suitable; install it in /etc/init.d, adapting it as necessary, and make
149 appropriate links from /etc/rc[0-6].d.
150
151 For Mac OS X 10.4, a suitable plist file is automatically installed. The
152 command:
153
154 sudo launchctl list
155
156 ...should show "uk.org.greenend.rjk.disorder" (among other things).
157
158 If you have a some other init system then you are on your own.
460b9539 159
1607. Make sure the state directory (/var/disorder or /usr/local/var/disorder or
161 as determined by configure) exists and is writable by the jukebox user.
162
163 mkdir -m 755 /var/disorder
164 chown disorder:root /var/disorder
165
e83d0967
RK
166 If you want to use some other directory you must put use the 'home' command
167 in the configuration file.
168
1698. Start the server.
170
171 On Linux systems with sysv-style init:
460b9539 172
173 /etc/init.d/disorder start
174
e83d0967
RK
175 On Mac OS X 10.4:
176
177 sudo launchctl start uk.org.greenend.rjk.disorder
178
460b9539 179 By default disorderd logs to daemon.*; check your syslog.conf to see where
180 this ends up and look for log messages from disorderd there. If it didn't
181 start up correctly there should be an error message. Correct the problem
182 and try again.
183
1849. After a minute it should start to play something. Try scratching it, as any
185 of the users you set up in step 5:
186
187 disorder scratch
188
189 The track should stop playing, and (if you set any up) a scratch sound play.
190
19110. Add any other users you want to config.private. Each user's password
192 should be stored in a file in their home directory, ~/.disorder/passwd,
193 which should be readable only by them, and should take the form of a single
194 line:
195
196 password MYPASSWORD
197
198 (root doesn't need this as the client can read it out of config.private
199 when running as root.)
200
201 Note that the server must be reloaded (e.g. by 'disorder reconfigure')
202 when new users are added.
203
204 Alternatively the administrator can create /etc/disorder/config.USERNAME
205 containing the same thing as above. It can either be owned by the user and
206 mode 400, or owned by root and the user's group (if you have per-user
207 groups) and mode 440.
208
209 You can use 'disorder authorize' to automatically pick passwords and
210 create these files.
211
21211. Optionally source completion.bash from /etc/profile or similar, for
213 example:
214
215 . /usr/local/share/disorder/completion.bash
216
217 This provides completion over disorder command and option names.
218
219
220Web Interface
221=============
222
223 "Thought I was a gonner baby, but I'm bullet proof"
224
225These instructions assumes you are using Apache 1.3.x.
226
227You need to configure a number of things to make this work:
228
2291. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
230 if you are somehow reading this in the 1980s) accordingly and use a fragment
231 such as this one:
232
233 <VirtualHost HOSTNAME>
234 DocumentRoot /home/jukebox/public_html
235 ServerName jukebox.DOMAIN
236 ServerAlias jukebox
237 ServerAdmin webmaster@DOMAIN
238 ErrorLog /var/log/apache/jukebox/error.log
239 TransferLog /var/log/apache/jukebox/access.log
240 Alias /static/ /usr/local/share/disorder/static/
241 </VirtualHost>
242
243 /static/ should point to the 'static' directory installed by DisOrder. If
244 you don't want to use the name 'static' then you can change the url.static
245 label in the web interface configuration to your preferred URL; see
246 disorder_config(5) for details.
247
248 Don't forget to reload Apache after modifying its configuration.
249
250 Separate logging is not required but I find it convenient. Up to you.
251
2522. disorder.cgi assumes it is subject to access control (and in particular uses
253 the username to report who did what). Here's how I configured Apache, given
254 the above VirtualHost settings:
255
256 <Directory /home/jukebox>
257 Require valid-user
258 AuthType basic
259 AuthName jukebox
260 AuthUserFile /home/jukebox/http.users
261 </Directory>
262
263 Adjust this according to wherever you're going to install disorder.cgi and
264 its expected URL.
265
266 Don't forget to reload apache after modifying its configuration. If you got
267 it wrong, fix it and restart Apache.
268
2693. Create the password file configured above. Something like this:
270
271 # htpasswd -b -c /home/jukebox/http.users myusername mypassword
272 Adding password for user myusername
273 # htpasswd -b /home/jukebox/http.users othername otherpass
274 Adding password for user othername
275
2764. The jukebox must be configured to trust the web user. I added the following
277 line to my /etc/disorder/config:
278
279 trust www-data
280
281 This might not be the same on your system! You have to specify the user
282 that the CGI script runs as, whatever that is.
283
2845. Install disorder.cgi in an appropriate location. Remember to make it
285 executable. With the above configuration I installed it as
286 ~jukebox/public_html/index.cgi.
287
2886. Give www-data (or whatever user it is) a password and edit
289 /etc/disorder/config.private accordingly. This file should be mode 640 and
290 owned by root:jukebox. The line should look something like this:
291
292 allow www-data MYPASSWORD
293
294 After editing the config file, you must make the daemon re-read it:
295
296 disorder reconfigure
297
2987. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
299 This file should be mode 640 and owned by root:www-data.
300
301 password MYPASSWORD
302
303 (You could also use ~www-data/.disorder/passwd for this but on some systems
304 the web server user's home directory is inside the document root, which
305 would have rather unfortunate consequences.)
306
3078. Try it out. You should be asked for a username and password that you
308 configured earlier, and be shown details of what is playing and what other
309 tracks have been configured for future play.
310
3119. Some features take time to start working, for instance those involving
312 reporting the length of tracks. This is because the server starts up as
313 quickly as possible even if the full track data has not yet been gathered;
314 the track data is then calculated in the background.
315
31610. If you run into problems, always look at the appropriate error log; the
317 message you see in your web browser will usually not be sufficient to
318 diagnose the problem all by itself.
319
32011. If you have a huge number of top level directories, then you might find
321 that the 'Choose' page is unreasonably large. If so add the following line
322 to /etc/disorder/options.user:
323 label sidebar.choosewhich choosealpha
324
325 This will make 'Choose' be a link for each letter of the 26-letter Roman
326 alphabet; follow the link and you just get the directories which start with
327 that letter. The "*" link at the end gives you directories which don't
328 start with a letter.
329
330 You can copy choosealpha.html to /etc/disorder and edit it to change the
331 set of initial choices to anything that can be expressed with regexps. The
332 regexps must be URL-encoded UTF-8 PCRE regexps.
333
334
335Copyright
336=========
337
338 "Nothing but another drug, a licence that you buy and sell"
339
340DisOrder - select and play digital audio files
eb525fcd 341Copyright (C) 2003-2007 Richard Kettlewell
460b9539 342Portions extracted from MPG321, http://mpg321.sourceforge.net/
343 Copyright (C) 2001 Joe Drew
344 Copyright (C) 2000-2001 Robert Leslie
345Binaries may derive extra copyright owners through linkage (binary distributors
346are expected to do their own legwork)
347
348This program is free software; you can redistribute it and/or modify it under
349the terms of the GNU General Public License as published by the Free Software
350Foundation; either version 2 of the License, or (at your option) any later
351version.
352
353This program is distributed in the hope that it will be useful, but WITHOUT ANY
354WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
355PARTICULAR PURPOSE. See the GNU General Public License for more details.
356
357You should have received a copy of the GNU General Public License along with
358this program; if not, write to the Free Software Foundation, Inc., 59 Temple
359Place, Suite 330, Boston, MA 02111-1307 USA
360
361Local Variables:
362mode:text
363fill-column:79
364End: