chiark / gitweb /
Start on 'settings' window. Currently disabled as it's not very
[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
5b14453f
RK
16See CHANGES for details of recent changes to DisOrder and README.upgrades for
17upgrade 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
37 GNU C 4.1.2
38 GNU Make 3.81
ddf922de 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
460b9539 51Mailing lists:
52 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
53 - discussion of DisOrder (and other software), bug reports, etc
54 http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
55 - announcements of new versions of DisOrder
56
91d9a42d 57Developers should read README.developers.
58
460b9539 59
7a4c02b0
RK
60Installation
61============
460b9539 62
63 "This place'd be a paradise tomorrow, if every department had a supervisor
64 with a machine-gun"
65
5b14453f 66IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
460b9539 67
7a4c02b0
RK
68Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
69files.
70
71OX X/FreeBSD/other Linux: after installation (step 1) 'sudo bash scripts/setup'
72covers steps 3 to 6. If it doesn't work on your platform, please get in touch.
73
460b9539 741. Build the software. Do something like this:
75
7a4c02b0
RK
76 ./configure
77 make # on FreeBSD use gmake
460b9539 78
7a4c02b0 79 See INSTALL or ./configure --help for more details about driving configure.
460b9539 80
81 If you only want to build a subset of DisOrder, specify one or more of the
82 following options:
83 --without-server Don't build server or web interface
84 --without-gtk Don't build GTK+ client (Disobedience)
85 --without-python Don't build Python support
86
655cae67
RK
87 See README.client for setting up a standalone client (or read the
88 disobedience man page).
89
7a4c02b0
RK
90 To build .debs on Debian/Ubuntu, use:
91 fakeroot debian/rules binary
92
460b9539 932. Install it. Most of the installation is done via the install target:
94
95 make installdirs install
96
813070ec
RK
97 The CGI interface has to be installed separately; see under 'Web Interface'
98 below.
460b9539 99
7a4c02b0
RK
100 NB steps 3 to 6 are covered by scripts/setup. It should work on FreeBSD, OS
101 X and Linux and could be adapted to other platforms.
102
460b9539 1033. Create a 'jukebox' user and group, with the jukebox group being the default
104 group of the jukebox user. The server will run as this user and group.
105 Check that this user can read your music files and write to the audio
106 device, e.g. by playing a track. The exact name doesn't matter, it could be
107 'jukebox' or 'disorder' or 'fred' or whatever.
108
109 Do not use a general-purpose user or group, you must create ones
110 specifically for DisOrder.
111
1124. Create /etc/disorder/config. Start from examples/config.sample and adapt it
be2d9f37 113 to your own requirements. The things you MUST do are:
460b9539 114 * edit the 'collection' command to identify the location(s) of your own
115 digital audio files. These commands also specify the encoding of
116 filenames, which you should be sure to get right as recovery from an
117 error here can be painful (see BUGS).
be2d9f37 118 Optionally you may also want to do the following:
e6a35d1c
RK
119 * add 'player' and 'tracklength' commands for any file formats not
120 supported natively
460b9539 121 * edit the 'scratch' commands to supply scratch sounds (or delete them if
122 you don't want any).
e6a35d1c
RK
123 * add extra 'stopword' entries as necessary (these words won't take part in
124 track name searches from the web interface).
460b9539 125
126 See disorder_config(5) for more details.
127
da6f7693
RK
128 See README.streams for how to set up network play.
129
130 If adding new 'player' commands, see README.raw for details on setting up
131 "raw format" players. Non-raw players are still supported but not in all
662886f6 132 configurations and they cannot support pausing and gapless play. If you
133 want additional formats to be supported natively please point the author at
134 a GPL-compatible library that can decode them.
6e2c9f5f 135
36be7e6a 1365. Make sure the server is started at boot time.
e83d0967
RK
137
138 On many Linux systems, examples/disorder.init should be more or less
139 suitable; install it in /etc/init.d, adapting it as necessary, and make
140 appropriate links from /etc/rc[0-6].d.
141
36be7e6a 1426. Start the server.
e83d0967
RK
143
144 On Linux systems with sysv-style init:
460b9539 145
146 /etc/init.d/disorder start
147
148 By default disorderd logs to daemon.*; check your syslog.conf to see where
149 this ends up and look for log messages from disorderd there. If it didn't
150 start up correctly there should be an error message. Correct the problem
151 and try again.
152
01f400ed
RK
1537. After a short while it should start to play something. Try scratching it
154 (as root):
460b9539 155
156 disorder scratch
157
158 The track should stop playing, and (if you set any up) a scratch sound play.
159
5f5fc693
RK
1608. Add any other users you want. These easiest way to do this is (still as
161 root):
460b9539 162
8ae47ac8 163 disorder authorize USERNAME
460b9539 164
f0feb22e 165 This will automatically choose a random password and create
5b14453f 166 ~USERNAME/.disorder/passwd.
460b9539 167
9025afab
RK
168 Those users should now be able to access the server from the same host as it
169 runs on, either via the disorder command or Disobedience. To run
170 Disobedience from some other host, File->Login allows hostnames, passwords
171 etc to be configured.
172
7a4c02b0
RK
173 Alternatively, after setting up the web interface (below), it's possible to
174 allow users to register themselves without operator involvement.
175
36be7e6a
RK
1769. Optionally source completion.bash from /etc/profile or similar, for
177 example:
460b9539 178
36be7e6a 179 . /usr/local/share/disorder/completion.bash
460b9539 180
36be7e6a 181 This provides completion over disorder command and option names.
460b9539 182
183
184Web Interface
185=============
186
187 "Thought I was a gonner baby, but I'm bullet proof"
188
7a4c02b0
RK
189Debian/Ubuntu: the .deb files will do the setup here automatically.
190
191OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
192here automatically.
460b9539 193
194You need to configure a number of things to make this work:
195
662886f6 1961. If you want online registration to work then set mail_sender in
e70701e7 197 /etc/disorder/config to the email address that communications from the web
563071c2 198 interface will appear to be sent. If this is not a valid, deliverable email
662886f6 199 address then the results are not likely to be reliable.
e70701e7 200
201 mail_sender webmaster@example.com
202
203 By default the web interface sends mail by connecting to the SMTP port of
204 127.0.0.1. You can override this with the smtp_server directive, for
205 exampler:
206
207 smtp_server mail.example.com
208
ad884aa5 209 Use 'disorder reconfigure' to make sure the server knows these settings.
210
e70701e7 2112. The web interface depends on a 'guest' user existing. You can create this
5e34540b 212 with the following command:
213
214 disorder setup-guest
215
216 If you don't want to allow online registration instead use:
217
a767291c 218 disorder setup-guest --no-online-registration
5e34540b 219
a767291c 2203. Make sure that DisOrder can find its icons and stylesheet. For example in
221 your web server configuration:
460b9539 222
5e34540b 223 Alias /disorder/ /usr/local/share/disorder/static/
460b9539 224
5e34540b 225 Alternatively you could use a symlink from the right location in your
226 document root, provided your web server is configured to follow them.
227
a767291c 228 cd /var/www
229 ln -s /usr/local/share/disorder/static disorder
460b9539 230
e70701e7 2314. Install disorder.cgi in an appropriate location. Remember to make it
a767291c 232 executable. Example:
5e34540b 233
758ec28f 234 install -m 755 server/disorder.cgi /usr/lib/cgi-bin/disorder
5e34540b 235
e70701e7 2365. Try it out. You should be able to perform read-only operations straight
d84bf422 237 away, and after visiting the 'Login' page to authenticate, perform other
238 operations like adding a track to the queue.
460b9539 239
e70701e7 2406. 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
e70701e7 2447. 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
272Binaries may derive extra copyright owners through linkage (binary distributors
273are expected to do their own legwork)
274
275This program is free software; you can redistribute it and/or modify it under
276the terms of the GNU General Public License as published by the Free Software
277Foundation; either version 2 of the License, or (at your option) any later
278version.
279
280This program is distributed in the hope that it will be useful, but WITHOUT ANY
281WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
282PARTICULAR PURPOSE. See the GNU General Public License for more details.
283
284You should have received a copy of the GNU General Public License along with
285this program; if not, write to the Free Software Foundation, Inc., 59 Temple
286Place, Suite 330, Boston, MA 02111-1307 USA
287
288Local Variables:
289mode:text
290fill-column:79
291End: