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