chiark / gitweb /
64-bit macos fix
[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:
23d0e963
RK
27 Name Tested Notes
28 libdb 4.3.29 not 4.2/4.6; 4.[457] seem to be ok
1a0d3568 29 libgc 6.8
30 libvorbisfile 1.1.2
23d0e963 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
23d0e963
RK
37 GNU C 4.1.2 }
38 GNU Make 3.81 } Non-GNU versions will NOT work
39 GNU Sed 4.1.5 }
40 Python 2.5.2 (optional; 2.4 won't work)
93c8c20f
RK
41 GTK+ 2.12.12 (for the GTK+ client; 2.10 & older will NOT work)
42 GLIB 2.16.6 (for 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
1746361e
RK
91 On a Mac you can use --with-bits=64 to request a 64-bit build. The default
92 is 32 bits. You will need suitable versions of all the libraries used.
93
64ac73bb
RK
94 If configure cannot guess where your web server keeps its HTML documents and
95 CGI programs, you may have to tell it, for instance:
4cbafe13 96
f03d4184 97 ./configure cgiexecdir=/whatever/cgi-bin httpdir=/whatever/htdocs
4cbafe13 98
655cae67
RK
99 See README.client for setting up a standalone client (or read the
100 disobedience man page).
101
7a4c02b0
RK
102 To build .debs on Debian/Ubuntu, use:
103 fakeroot debian/rules binary
104
460b9539 1052. Install it. Most of the installation is done via the install target:
106
107 make installdirs install
108
7a4c02b0
RK
109 NB steps 3 to 6 are covered by scripts/setup. It should work on FreeBSD, OS
110 X and Linux and could be adapted to other platforms.
111
460b9539 1123. Create a 'jukebox' user and group, with the jukebox group being the default
113 group of the jukebox user. The server will run as this user and group.
114 Check that this user can read your music files and write to the audio
115 device, e.g. by playing a track. The exact name doesn't matter, it could be
116 'jukebox' or 'disorder' or 'fred' or whatever.
117
118 Do not use a general-purpose user or group, you must create ones
119 specifically for DisOrder.
120
1214. Create /etc/disorder/config. Start from examples/config.sample and adapt it
be2d9f37 122 to your own requirements. The things you MUST do are:
460b9539 123 * edit the 'collection' command to identify the location(s) of your own
124 digital audio files. These commands also specify the encoding of
125 filenames, which you should be sure to get right as recovery from an
126 error here can be painful (see BUGS).
be2d9f37 127 Optionally you may also want to do the following:
e6a35d1c
RK
128 * add 'player' and 'tracklength' commands for any file formats not
129 supported natively
460b9539 130 * edit the 'scratch' commands to supply scratch sounds (or delete them if
131 you don't want any).
e6a35d1c
RK
132 * add extra 'stopword' entries as necessary (these words won't take part in
133 track name searches from the web interface).
460b9539 134
135 See disorder_config(5) for more details.
136
da6f7693
RK
137 See README.streams for how to set up network play.
138
139 If adding new 'player' commands, see README.raw for details on setting up
140 "raw format" players. Non-raw players are still supported but not in all
662886f6 141 configurations and they cannot support pausing and gapless play. If you
142 want additional formats to be supported natively please point the author at
143 a GPL-compatible library that can decode them.
6e2c9f5f 144
36be7e6a 1455. Make sure the server is started at boot time.
e83d0967
RK
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
36be7e6a 1516. Start the server.
e83d0967
RK
152
153 On Linux systems with sysv-style init:
460b9539 154
155 /etc/init.d/disorder start
156
157 By default disorderd logs to daemon.*; check your syslog.conf to see where
158 this ends up and look for log messages from disorderd there. If it didn't
159 start up correctly there should be an error message. Correct the problem
160 and try again.
161
01f400ed
RK
1627. After a short while it should start to play something. Try scratching it
163 (as root):
460b9539 164
165 disorder scratch
166
167 The track should stop playing, and (if you set any up) a scratch sound play.
168
5f5fc693
RK
1698. Add any other users you want. These easiest way to do this is (still as
170 root):
460b9539 171
8ae47ac8 172 disorder authorize USERNAME
460b9539 173
f0feb22e 174 This will automatically choose a random password and create
5b14453f 175 ~USERNAME/.disorder/passwd.
460b9539 176
9025afab
RK
177 Those users should now be able to access the server from the same host as it
178 runs on, either via the disorder command or Disobedience. To run
179 Disobedience from some other host, File->Login allows hostnames, passwords
180 etc to be configured.
181
7a4c02b0
RK
182 Alternatively, after setting up the web interface (below), it's possible to
183 allow users to register themselves without operator involvement.
184
36be7e6a
RK
1859. Optionally source completion.bash from /etc/profile or similar, for
186 example:
460b9539 187
36be7e6a 188 . /usr/local/share/disorder/completion.bash
460b9539 189
36be7e6a 190 This provides completion over disorder command and option names.
460b9539 191
192
193Web Interface
194=============
195
196 "Thought I was a gonner baby, but I'm bullet proof"
197
7a4c02b0
RK
198Debian/Ubuntu: the .deb files will do the setup here automatically.
199
200OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
201here automatically.
460b9539 202
203You need to configure a number of things to make this work:
204
662886f6 2051. If you want online registration to work then set mail_sender in
e70701e7 206 /etc/disorder/config to the email address that communications from the web
563071c2 207 interface will appear to be sent. If this is not a valid, deliverable email
662886f6 208 address then the results are not likely to be reliable.
e70701e7 209
210 mail_sender webmaster@example.com
211
2eee4b0c
RK
212 By default the web interface sends mail via the system sendmail executable
213 (typically /usr/sbin/sendmail or /usr/lib/sendmail). You can override this
214 with the sendmail directive, for example:
215
216 sendmail /usr/sbin/my-sendmail
217
218 The executable you choose must support the -bs option. Alternatively you
219 can tell it to connect to an SMTP server via TCP, with the smtp_server
220 directive. For example:
e70701e7 221
222 smtp_server mail.example.com
223
ad884aa5 224 Use 'disorder reconfigure' to make sure the server knows these settings.
225
e70701e7 2262. The web interface depends on a 'guest' user existing. You can create this
5e34540b 227 with the following command:
228
229 disorder setup-guest
230
231 If you don't want to allow online registration instead use:
232
a767291c 233 disorder setup-guest --no-online-registration
5e34540b 234
d576d190
RK
2353. Try it out. The url will be (something like):
236
237 http://localhost/cgi-bin/disorder
238
239 You should be able to perform read-only operations straight away, and after
240 visiting the 'Login' page to authenticate, perform other operations like
241 adding a track to the queue.
460b9539 242
64ac73bb 2434. If you run into problems, always look at the appropriate error log; the
5e34540b 244 message you see in your web browser will usually not be sufficient to
245 diagnose the problem all by itself.
460b9539 246
64ac73bb 2475. If you have a huge number of top level directories, then you might find
5e34540b 248 that the 'Choose' page is unreasonably large. If so add the following line
249 to /etc/disorder/options.user:
250 label sidebar.choosewhich choosealpha
251
252 This will make 'Choose' be a link for each letter of the 26-letter Roman
253 alphabet; follow the link and you just get the directories which start with
254 that letter. The "*" link at the end gives you directories which don't
255 start with a letter.
256
257 You can copy choosealpha.html to /etc/disorder and edit it to change the
258 set of initial choices to anything that can be expressed with regexps. The
259 regexps must be URL-encoded UTF-8 PCRE regexps.
460b9539 260
a767291c 261If you want to give DisOrder its own virtual host, see README.vhost.
460b9539 262
263Copyright
264=========
265
266 "Nothing but another drug, a licence that you buy and sell"
267
268DisOrder - select and play digital audio files
4778e044 269Copyright (C) 2003-2009 Richard Kettlewell
313acc77
RK
270Portions copyright (C) 2007 Ross Younger
271Portions copyright (C) 2007 Mark Wooding
460b9539 272Portions extracted from MPG321, http://mpg321.sourceforge.net/
273 Copyright (C) 2001 Joe Drew
274 Copyright (C) 2000-2001 Robert Leslie
d436bd52 275Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
56293dc8 276Portions Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
460b9539 277Binaries may derive extra copyright owners through linkage (binary distributors
278are expected to do their own legwork)
279
e7eb3a27
RK
280This program is free software: you can redistribute it and/or modify
281it under the terms of the GNU General Public License as published by
282the Free Software Foundation, either version 3 of the License, or
283(at your option) any later version.
284
285This program is distributed in the hope that it will be useful,
286but WITHOUT ANY WARRANTY; without even the implied warranty of
287MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
288GNU General Public License for more details.
289
290You should have received a copy of the GNU General Public License
291along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 292
293Local Variables:
294mode:text
295fill-column:79
296End: