chiark / gitweb /
Doxygen file headers for most files
[disorder] / README
CommitLineData
460b9539 1DisOrder
2========
3
9025afab
RK
4DisOrder 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
5b14453f 11 word or tag search.
9025afab
RK
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").
460b9539 15
b0a578cb
RK
16See CHANGES.html for details of recent changes to DisOrder and README.upgrades
17for upgrade instructions.
460b9539 18
7a4c02b0
RK
19Platform support:
20 Linux Well tested on Debian
21 Mac OS X Disobedience well tested, server somewhat tested; use fink
22 FreeBSD Scantily tested; use ports for dependencies
23It could probably be ported to some other UNIX variants without too much
24effort.
460b9539 25
26Build dependencies:
27 Name Tested Notes
662886f6 28 libdb 4.3.29 not 4.2.x; 4.4+ might work.
1a0d3568 29 libgc 6.8
30 libvorbisfile 1.1.2
31 libpcre 6.7 need UTF-8 support
460b9539 32 libmad 0.15.1b
1a0d3568 33 libgcrypt 1.2.3
460b9539 34 libao 0.8.6
1a0d3568 35 libasound 1.0.13
36 libFLAC 1.1.2
50450a00
RK
37 GNU C 4.1.2 }
38 GNU Make 3.81 } Non-GNU versions will NOT work
39 GNU Sed 4.1.5 }
1a0d3568 40 Python 2.4.4 (optional)
41 GTK+ 2.8.20 (if you want the GTK+ client)
42 GLIB 2.12.4 (if you want the GTK+ client)
460b9539 43
44"Tested" means I've built against that version; earlier or later versions will
45often work too.
46
91d9a42d 47For the web interface to work you will additionally need a web server. I've
48had both Apache 1.3.x and 2.x working. Anything that supports CGI should be
49OK.
e9194ec6 50
802cbf55
RK
51Bug tracker, etc:
52 http://code.google.com/p/disorder/
53
460b9539 54Mailing lists:
55 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
56 - discussion of DisOrder (and other software), bug reports, etc
57 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
58 - announcements of new versions of DisOrder
59
91d9a42d 60Developers should read README.developers.
61
460b9539 62
7a4c02b0
RK
63Installation
64============
460b9539 65
66 "This place'd be a paradise tomorrow, if every department had a supervisor
67 with a machine-gun"
68
5b14453f 69IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
460b9539 70
7a4c02b0
RK
71Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
72files.
73
f3e157f7
RK
74OX X/FreeBSD/other Linux: after installation (step 1 and 2), running
75'sudo bash scripts/setup' will cover steps 3 to 6. If it doesn't work on your
76platform, please get in touch.
7a4c02b0 77
460b9539 781. Build the software. Do something like this:
79
7a4c02b0
RK
80 ./configure
81 make # on FreeBSD use gmake
460b9539 82
7a4c02b0 83 See INSTALL or ./configure --help for more details about driving configure.
460b9539 84
85 If you only want to build a subset of DisOrder, specify one or more of the
86 following options:
87 --without-server Don't build server or web interface
88 --without-gtk Don't build GTK+ client (Disobedience)
89 --without-python Don't build Python support
90
64ac73bb
RK
91 If configure cannot guess where your web server keeps its HTML documents and
92 CGI programs, you may have to tell it, for instance:
4cbafe13 93
f03d4184 94 ./configure cgiexecdir=/whatever/cgi-bin httpdir=/whatever/htdocs
4cbafe13 95
655cae67
RK
96 See README.client for setting up a standalone client (or read the
97 disobedience man page).
98
7a4c02b0
RK
99 To build .debs on Debian/Ubuntu, use:
100 fakeroot debian/rules binary
101
460b9539 1022. Install it. Most of the installation is done via the install target:
103
104 make installdirs install
105
7a4c02b0
RK
106 NB steps 3 to 6 are covered by scripts/setup. It should work on FreeBSD, OS
107 X and Linux and could be adapted to other platforms.
108
460b9539 1093. Create a 'jukebox' user and group, with the jukebox group being the default
110 group of the jukebox user. The server will run as this user and group.
111 Check that this user can read your music files and write to the audio
112 device, e.g. by playing a track. The exact name doesn't matter, it could be
113 'jukebox' or 'disorder' or 'fred' or whatever.
114
115 Do not use a general-purpose user or group, you must create ones
116 specifically for DisOrder.
117
1184. Create /etc/disorder/config. Start from examples/config.sample and adapt it
be2d9f37 119 to your own requirements. The things you MUST do are:
460b9539 120 * edit the 'collection' command to identify the location(s) of your own
121 digital audio files. These commands also specify the encoding of
122 filenames, which you should be sure to get right as recovery from an
123 error here can be painful (see BUGS).
be2d9f37 124 Optionally you may also want to do the following:
e6a35d1c
RK
125 * add 'player' and 'tracklength' commands for any file formats not
126 supported natively
460b9539 127 * edit the 'scratch' commands to supply scratch sounds (or delete them if
128 you don't want any).
e6a35d1c
RK
129 * add extra 'stopword' entries as necessary (these words won't take part in
130 track name searches from the web interface).
460b9539 131
132 See disorder_config(5) for more details.
133
da6f7693
RK
134 See README.streams for how to set up network play.
135
136 If adding new 'player' commands, see README.raw for details on setting up
137 "raw format" players. Non-raw players are still supported but not in all
662886f6 138 configurations and they cannot support pausing and gapless play. If you
139 want additional formats to be supported natively please point the author at
140 a GPL-compatible library that can decode them.
6e2c9f5f 141
36be7e6a 1425. Make sure the server is started at boot time.
e83d0967
RK
143
144 On many Linux systems, examples/disorder.init should be more or less
145 suitable; install it in /etc/init.d, adapting it as necessary, and make
146 appropriate links from /etc/rc[0-6].d.
147
36be7e6a 1486. Start the server.
e83d0967
RK
149
150 On Linux systems with sysv-style init:
460b9539 151
152 /etc/init.d/disorder start
153
154 By default disorderd logs to daemon.*; check your syslog.conf to see where
155 this ends up and look for log messages from disorderd there. If it didn't
156 start up correctly there should be an error message. Correct the problem
157 and try again.
158
01f400ed
RK
1597. After a short while it should start to play something. Try scratching it
160 (as root):
460b9539 161
162 disorder scratch
163
164 The track should stop playing, and (if you set any up) a scratch sound play.
165
5f5fc693
RK
1668. Add any other users you want. These easiest way to do this is (still as
167 root):
460b9539 168
8ae47ac8 169 disorder authorize USERNAME
460b9539 170
f0feb22e 171 This will automatically choose a random password and create
5b14453f 172 ~USERNAME/.disorder/passwd.
460b9539 173
9025afab
RK
174 Those users should now be able to access the server from the same host as it
175 runs on, either via the disorder command or Disobedience. To run
176 Disobedience from some other host, File->Login allows hostnames, passwords
177 etc to be configured.
178
7a4c02b0
RK
179 Alternatively, after setting up the web interface (below), it's possible to
180 allow users to register themselves without operator involvement.
181
36be7e6a
RK
1829. Optionally source completion.bash from /etc/profile or similar, for
183 example:
460b9539 184
36be7e6a 185 . /usr/local/share/disorder/completion.bash
460b9539 186
36be7e6a 187 This provides completion over disorder command and option names.
460b9539 188
189
190Web Interface
191=============
192
193 "Thought I was a gonner baby, but I'm bullet proof"
194
7a4c02b0
RK
195Debian/Ubuntu: the .deb files will do the setup here automatically.
196
197OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
198here automatically.
460b9539 199
200You need to configure a number of things to make this work:
201
662886f6 2021. If you want online registration to work then set mail_sender in
e70701e7 203 /etc/disorder/config to the email address that communications from the web
563071c2 204 interface will appear to be sent. If this is not a valid, deliverable email
662886f6 205 address then the results are not likely to be reliable.
e70701e7 206
207 mail_sender webmaster@example.com
208
2eee4b0c
RK
209 By default the web interface sends mail via the system sendmail executable
210 (typically /usr/sbin/sendmail or /usr/lib/sendmail). You can override this
211 with the sendmail directive, for example:
212
213 sendmail /usr/sbin/my-sendmail
214
215 The executable you choose must support the -bs option. Alternatively you
216 can tell it to connect to an SMTP server via TCP, with the smtp_server
217 directive. For example:
e70701e7 218
219 smtp_server mail.example.com
220
ad884aa5 221 Use 'disorder reconfigure' to make sure the server knows these settings.
222
e70701e7 2232. The web interface depends on a 'guest' user existing. You can create this
5e34540b 224 with the following command:
225
226 disorder setup-guest
227
228 If you don't want to allow online registration instead use:
229
a767291c 230 disorder setup-guest --no-online-registration
5e34540b 231
d576d190
RK
2323. Try it out. The url will be (something like):
233
234 http://localhost/cgi-bin/disorder
235
236 You should be able to perform read-only operations straight away, and after
237 visiting the 'Login' page to authenticate, perform other operations like
238 adding a track to the queue.
460b9539 239
64ac73bb 2404. If you run into problems, always look at the appropriate error log; the
5e34540b 241 message you see in your web browser will usually not be sufficient to
242 diagnose the problem all by itself.
460b9539 243
64ac73bb 2445. If you have a huge number of top level directories, then you might find
5e34540b 245 that the 'Choose' page is unreasonably large. If so add the following line
246 to /etc/disorder/options.user:
247 label sidebar.choosewhich choosealpha
248
249 This will make 'Choose' be a link for each letter of the 26-letter Roman
250 alphabet; follow the link and you just get the directories which start with
251 that letter. The "*" link at the end gives you directories which don't
252 start with a letter.
253
254 You can copy choosealpha.html to /etc/disorder and edit it to change the
255 set of initial choices to anything that can be expressed with regexps. The
256 regexps must be URL-encoded UTF-8 PCRE regexps.
460b9539 257
a767291c 258If you want to give DisOrder its own virtual host, see README.vhost.
460b9539 259
260Copyright
261=========
262
263 "Nothing but another drug, a licence that you buy and sell"
264
265DisOrder - select and play digital audio files
8f9616f1 266Copyright (C) 2003-2008 Richard Kettlewell
313acc77
RK
267Portions copyright (C) 2007 Ross Younger
268Portions copyright (C) 2007 Mark Wooding
460b9539 269Portions extracted from MPG321, http://mpg321.sourceforge.net/
270 Copyright (C) 2001 Joe Drew
271 Copyright (C) 2000-2001 Robert Leslie
d436bd52 272Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
460b9539 273Binaries may derive extra copyright owners through linkage (binary distributors
274are expected to do their own legwork)
275
e7eb3a27
RK
276This program is free software: you can redistribute it and/or modify
277it under the terms of the GNU General Public License as published by
278the Free Software Foundation, either version 3 of the License, or
279(at your option) any later version.
280
281This program is distributed in the hope that it will be useful,
282but WITHOUT ANY WARRANTY; without even the implied warranty of
283MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
284GNU General Public License for more details.
285
286You should have received a copy of the GNU General Public License
287along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 288
289Local Variables:
290mode:text
291fill-column:79
292End: