chiark / gitweb /
FLAC support in tracklength plugin
[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
6e2c9f5f
RK
121 See README.raw for details on setting up "raw format" players, which allow
122 for pausing and gapless play.
123
460b9539 1245. Create /etc/disorder/config.private. This should be readable only by the
125 jukebox group:
126
127 touch /etc/disorder/config.private
128 chown root:jukebox /etc/disorder/config.private
129 chmod 640 /etc/disorder/config.private
130
131 Set up a username and password for root, for example with line like this:
132
133 allow root somepassword
134
135 Use (for instance) pwgen(1) to create the password. DO NOT use your root
136 password - this is a password to give root access to the server, not to give
137 access to the root login.
138
139 See disorderd(8) and disorder_config(5) for more details.
140
e83d0967
RK
1416. Make sure the server is started at boot time.
142
143 On many Linux systems, examples/disorder.init should be more or less
144 suitable; install it in /etc/init.d, adapting it as necessary, and make
145 appropriate links from /etc/rc[0-6].d.
146
147 For Mac OS X 10.4, a suitable plist file is automatically installed. The
148 command:
149
150 sudo launchctl list
151
152 ...should show "uk.org.greenend.rjk.disorder" (among other things).
153
154 If you have a some other init system then you are on your own.
460b9539 155
1567. Make sure the state directory (/var/disorder or /usr/local/var/disorder or
157 as determined by configure) exists and is writable by the jukebox user.
158
159 mkdir -m 755 /var/disorder
160 chown disorder:root /var/disorder
161
e83d0967
RK
162 If you want to use some other directory you must put use the 'home' command
163 in the configuration file.
164
1658. Start the server.
166
167 On Linux systems with sysv-style init:
460b9539 168
169 /etc/init.d/disorder start
170
e83d0967
RK
171 On Mac OS X 10.4:
172
173 sudo launchctl start uk.org.greenend.rjk.disorder
174
460b9539 175 By default disorderd logs to daemon.*; check your syslog.conf to see where
176 this ends up and look for log messages from disorderd there. If it didn't
177 start up correctly there should be an error message. Correct the problem
178 and try again.
179
1809. After a minute it should start to play something. Try scratching it, as any
181 of the users you set up in step 5:
182
183 disorder scratch
184
185 The track should stop playing, and (if you set any up) a scratch sound play.
186
18710. Add any other users you want to config.private. Each user's password
188 should be stored in a file in their home directory, ~/.disorder/passwd,
189 which should be readable only by them, and should take the form of a single
190 line:
191
192 password MYPASSWORD
193
194 (root doesn't need this as the client can read it out of config.private
195 when running as root.)
196
197 Note that the server must be reloaded (e.g. by 'disorder reconfigure')
198 when new users are added.
199
200 Alternatively the administrator can create /etc/disorder/config.USERNAME
201 containing the same thing as above. It can either be owned by the user and
202 mode 400, or owned by root and the user's group (if you have per-user
203 groups) and mode 440.
204
205 You can use 'disorder authorize' to automatically pick passwords and
206 create these files.
207
20811. Optionally source completion.bash from /etc/profile or similar, for
209 example:
210
211 . /usr/local/share/disorder/completion.bash
212
213 This provides completion over disorder command and option names.
214
215
216Web Interface
217=============
218
219 "Thought I was a gonner baby, but I'm bullet proof"
220
221These instructions assumes you are using Apache 1.3.x.
222
223You need to configure a number of things to make this work:
224
2251. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
226 if you are somehow reading this in the 1980s) accordingly and use a fragment
227 such as this one:
228
229 <VirtualHost HOSTNAME>
230 DocumentRoot /home/jukebox/public_html
231 ServerName jukebox.DOMAIN
232 ServerAlias jukebox
233 ServerAdmin webmaster@DOMAIN
234 ErrorLog /var/log/apache/jukebox/error.log
235 TransferLog /var/log/apache/jukebox/access.log
236 Alias /static/ /usr/local/share/disorder/static/
237 </VirtualHost>
238
239 /static/ should point to the 'static' directory installed by DisOrder. If
240 you don't want to use the name 'static' then you can change the url.static
241 label in the web interface configuration to your preferred URL; see
242 disorder_config(5) for details.
243
244 Don't forget to reload Apache after modifying its configuration.
245
246 Separate logging is not required but I find it convenient. Up to you.
247
2482. disorder.cgi assumes it is subject to access control (and in particular uses
249 the username to report who did what). Here's how I configured Apache, given
250 the above VirtualHost settings:
251
252 <Directory /home/jukebox>
253 Require valid-user
254 AuthType basic
255 AuthName jukebox
256 AuthUserFile /home/jukebox/http.users
257 </Directory>
258
259 Adjust this according to wherever you're going to install disorder.cgi and
260 its expected URL.
261
262 Don't forget to reload apache after modifying its configuration. If you got
263 it wrong, fix it and restart Apache.
264
2653. Create the password file configured above. Something like this:
266
267 # htpasswd -b -c /home/jukebox/http.users myusername mypassword
268 Adding password for user myusername
269 # htpasswd -b /home/jukebox/http.users othername otherpass
270 Adding password for user othername
271
2724. The jukebox must be configured to trust the web user. I added the following
273 line to my /etc/disorder/config:
274
275 trust www-data
276
277 This might not be the same on your system! You have to specify the user
278 that the CGI script runs as, whatever that is.
279
2805. Install disorder.cgi in an appropriate location. Remember to make it
281 executable. With the above configuration I installed it as
282 ~jukebox/public_html/index.cgi.
283
2846. Give www-data (or whatever user it is) a password and edit
285 /etc/disorder/config.private accordingly. This file should be mode 640 and
286 owned by root:jukebox. The line should look something like this:
287
288 allow www-data MYPASSWORD
289
290 After editing the config file, you must make the daemon re-read it:
291
292 disorder reconfigure
293
2947. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
295 This file should be mode 640 and owned by root:www-data.
296
297 password MYPASSWORD
298
299 (You could also use ~www-data/.disorder/passwd for this but on some systems
300 the web server user's home directory is inside the document root, which
301 would have rather unfortunate consequences.)
302
3038. Try it out. You should be asked for a username and password that you
304 configured earlier, and be shown details of what is playing and what other
305 tracks have been configured for future play.
306
3079. Some features take time to start working, for instance those involving
308 reporting the length of tracks. This is because the server starts up as
309 quickly as possible even if the full track data has not yet been gathered;
310 the track data is then calculated in the background.
311
31210. If you run into problems, always look at the appropriate error log; the
313 message you see in your web browser will usually not be sufficient to
314 diagnose the problem all by itself.
315
31611. If you have a huge number of top level directories, then you might find
317 that the 'Choose' page is unreasonably large. If so add the following line
318 to /etc/disorder/options.user:
319 label sidebar.choosewhich choosealpha
320
321 This will make 'Choose' be a link for each letter of the 26-letter Roman
322 alphabet; follow the link and you just get the directories which start with
323 that letter. The "*" link at the end gives you directories which don't
324 start with a letter.
325
326 You can copy choosealpha.html to /etc/disorder and edit it to change the
327 set of initial choices to anything that can be expressed with regexps. The
328 regexps must be URL-encoded UTF-8 PCRE regexps.
329
330
331Copyright
332=========
333
334 "Nothing but another drug, a licence that you buy and sell"
335
336DisOrder - select and play digital audio files
eb525fcd 337Copyright (C) 2003-2007 Richard Kettlewell
460b9539 338Portions extracted from MPG321, http://mpg321.sourceforge.net/
339 Copyright (C) 2001 Joe Drew
340 Copyright (C) 2000-2001 Robert Leslie
341Binaries may derive extra copyright owners through linkage (binary distributors
342are expected to do their own legwork)
343
344This program is free software; you can redistribute it and/or modify it under
345the terms of the GNU General Public License as published by the Free Software
346Foundation; either version 2 of the License, or (at your option) any later
347version.
348
349This program is distributed in the hope that it will be useful, but WITHOUT ANY
350WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
351PARTICULAR PURPOSE. See the GNU General Public License for more details.
352
353You should have received a copy of the GNU General Public License along with
354this program; if not, write to the Free Software Foundation, Inc., 59 Temple
355Place, Suite 330, Boston, MA 02111-1307 USA
356
357Local Variables:
358mode:text
359fill-column:79
360End: