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 | |
11 | word search. | |
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 | |
16 | See CHANGES for details of recent changes to DisOrder. | |
17 | ||
5f5fc693 RK |
18 | The server supports Linux and can be made to work on a Mac (see README.mac). |
19 | The clients work on both Linux and the Mac. It could probably be ported to | |
20 | some other UNIX variants without too much effort. Things you will need: | |
460b9539 | 21 | |
22 | Build dependencies: | |
23 | Name Tested Notes | |
662886f6 | 24 | libdb 4.3.29 not 4.2.x; 4.4+ might work. |
1a0d3568 | 25 | libgc 6.8 |
26 | libvorbisfile 1.1.2 | |
27 | libpcre 6.7 need UTF-8 support | |
460b9539 | 28 | libmad 0.15.1b |
1a0d3568 | 29 | libgcrypt 1.2.3 |
460b9539 | 30 | libao 0.8.6 |
1a0d3568 | 31 | libasound 1.0.13 |
32 | libFLAC 1.1.2 | |
33 | GNU C 4.1.2 | |
34 | GNU Make 3.81 | |
ddf922de | 35 | GNU Sed 4.1.5 |
1a0d3568 | 36 | Python 2.4.4 (optional) |
37 | GTK+ 2.8.20 (if you want the GTK+ client) | |
38 | GLIB 2.12.4 (if you want the GTK+ client) | |
460b9539 | 39 | |
40 | "Tested" means I've built against that version; earlier or later versions will | |
41 | often work too. | |
42 | ||
43 | Runtime dependencies: | |
460b9539 | 44 | * Web server: |
45 | + Apache 1.3.x works for me, but anything that supports CGI and | |
46 | authentication should be suitable. | |
1a0d3568 | 47 | * Separate player programs are no longer required (but may still be used) |
460b9539 | 48 | |
49 | Development dependencies (only developers will need these): | |
1a0d3568 | 50 | Automake 1.10 AM_PATH_PYTHON not good enough in 1.7 |
51 | Autoconf 2.61 | |
52 | Libtool 1.5.22 1.4 not good enough | |
39068fb4 | 53 | Bazaar (bzr) |
460b9539 | 54 | |
e9194ec6 | 55 | On Debian you might ensure you have the required packages as follows: |
56 | apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \ | |
57 | libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \ | |
1a0d3568 | 58 | libao-dev libmad0-dev libasound2-dev libdb4.3-dev \ |
59 | libflac-dev | |
e9194ec6 | 60 | |
460b9539 | 61 | Mailing lists: |
62 | http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss | |
63 | - discussion of DisOrder (and other software), bug reports, etc | |
64 | http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce | |
65 | - announcements of new versions of DisOrder | |
66 | ||
67 | ||
68 | Installation | |
69 | ============ | |
70 | ||
71 | "This place'd be a paradise tomorrow, if every department had a supervisor | |
72 | with a machine-gun" | |
73 | ||
74 | NOTE: If you are upgrading from an earlier version, see README.upgrades. | |
75 | ||
5f5fc693 RK |
76 | On a Debian system, if you install from .deb files then you should be able to |
77 | skip steps 1 to 6 and configure it via debconf. This is strongly recommended! | |
78 | ||
460b9539 | 79 | 1. Build the software. Do something like this: |
80 | ||
81 | ./configure --sysconfdir=/etc --localstatedir=/var | |
82 | make | |
83 | ||
84 | See INSTALL for more details about driving configure. The precise set of | |
85 | options you pass to configure is up to you, if you like configuration being | |
86 | in /usr/local/etc or wherever then that should work. | |
87 | ||
88 | If you only want to build a subset of DisOrder, specify one or more of the | |
89 | following options: | |
90 | --without-server Don't build server or web interface | |
91 | --without-gtk Don't build GTK+ client (Disobedience) | |
92 | --without-python Don't build Python support | |
93 | ||
655cae67 RK |
94 | See README.client for setting up a standalone client (or read the |
95 | disobedience man page). | |
96 | ||
460b9539 | 97 | 2. Install it. Most of the installation is done via the install target: |
98 | ||
99 | make installdirs install | |
100 | ||
813070ec RK |
101 | The CGI interface has to be installed separately; see under 'Web Interface' |
102 | below. | |
460b9539 | 103 | |
460b9539 | 104 | 3. Create a 'jukebox' user and group, with the jukebox group being the default |
105 | group of the jukebox user. The server will run as this user and group. | |
106 | Check that this user can read your music files and write to the audio | |
107 | device, e.g. by playing a track. The exact name doesn't matter, it could be | |
108 | 'jukebox' or 'disorder' or 'fred' or whatever. | |
109 | ||
110 | Do not use a general-purpose user or group, you must create ones | |
111 | specifically for DisOrder. | |
112 | ||
113 | 4. Create /etc/disorder/config. Start from examples/config.sample and adapt it | |
be2d9f37 | 114 | to your own requirements. The things you MUST do are: |
460b9539 | 115 | * edit the 'collection' command to identify the location(s) of your own |
116 | digital audio files. These commands also specify the encoding of | |
117 | filenames, which you should be sure to get right as recovery from an | |
118 | error here can be painful (see BUGS). | |
be2d9f37 | 119 | Optionally you may also want to do the following: |
e6a35d1c RK |
120 | * add 'player' and 'tracklength' commands for any file formats not |
121 | supported natively | |
460b9539 | 122 | * edit the 'scratch' commands to supply scratch sounds (or delete them if |
123 | you don't want any). | |
e6a35d1c RK |
124 | * add extra 'stopword' entries as necessary (these words won't take part in |
125 | track name searches from the web interface). | |
460b9539 | 126 | |
127 | See disorder_config(5) for more details. | |
128 | ||
da6f7693 RK |
129 | See README.streams for how to set up network play. |
130 | ||
131 | If adding new 'player' commands, see README.raw for details on setting up | |
132 | "raw format" players. Non-raw players are still supported but not in all | |
662886f6 | 133 | configurations and they cannot support pausing and gapless play. If you |
134 | want additional formats to be supported natively please point the author at | |
135 | a GPL-compatible library that can decode them. | |
6e2c9f5f | 136 | |
36be7e6a | 137 | 5. Make sure the server is started at boot time. |
e83d0967 RK |
138 | |
139 | On many Linux systems, examples/disorder.init should be more or less | |
140 | suitable; install it in /etc/init.d, adapting it as necessary, and make | |
141 | appropriate links from /etc/rc[0-6].d. | |
142 | ||
36be7e6a | 143 | 6. Start the server. |
e83d0967 RK |
144 | |
145 | On Linux systems with sysv-style init: | |
460b9539 | 146 | |
147 | /etc/init.d/disorder start | |
148 | ||
149 | By default disorderd logs to daemon.*; check your syslog.conf to see where | |
150 | this ends up and look for log messages from disorderd there. If it didn't | |
151 | start up correctly there should be an error message. Correct the problem | |
152 | and try again. | |
153 | ||
01f400ed RK |
154 | 7. After a short while it should start to play something. Try scratching it |
155 | (as root): | |
460b9539 | 156 | |
157 | disorder scratch | |
158 | ||
159 | The track should stop playing, and (if you set any up) a scratch sound play. | |
160 | ||
5f5fc693 RK |
161 | 8. Add any other users you want. These easiest way to do this is (still as |
162 | root): | |
460b9539 | 163 | |
8ae47ac8 | 164 | disorder authorize USERNAME |
460b9539 | 165 | |
f0feb22e RK |
166 | This will automatically choose a random password and create |
167 | /etc/disorder/config.USERNAME. | |
460b9539 | 168 | |
9025afab RK |
169 | Those users should now be able to access the server from the same host as it |
170 | runs on, either via the disorder command or Disobedience. To run | |
171 | Disobedience from some other host, File->Login allows hostnames, passwords | |
172 | etc to be configured. | |
173 | ||
36be7e6a RK |
174 | 9. Optionally source completion.bash from /etc/profile or similar, for |
175 | example: | |
460b9539 | 176 | |
36be7e6a | 177 | . /usr/local/share/disorder/completion.bash |
460b9539 | 178 | |
36be7e6a | 179 | This provides completion over disorder command and option names. |
460b9539 | 180 | |
181 | ||
182 | Web Interface | |
183 | ============= | |
184 | ||
185 | "Thought I was a gonner baby, but I'm bullet proof" | |
186 | ||
a767291c | 187 | As above, if you install from a .deb, much of the work will be done |
188 | automatically. | |
460b9539 | 189 | |
190 | You need to configure a number of things to make this work: | |
191 | ||
662886f6 | 192 | 1. If you want online registration to work then set mail_sender in |
e70701e7 | 193 | /etc/disorder/config to the email address that communications from the web |
563071c2 | 194 | interface will appear to be sent. If this is not a valid, deliverable email |
662886f6 | 195 | address then the results are not likely to be reliable. |
e70701e7 | 196 | |
197 | mail_sender webmaster@example.com | |
198 | ||
199 | By default the web interface sends mail by connecting to the SMTP port of | |
200 | 127.0.0.1. You can override this with the smtp_server directive, for | |
201 | exampler: | |
202 | ||
203 | smtp_server mail.example.com | |
204 | ||
205 | 2. The web interface depends on a 'guest' user existing. You can create this | |
5e34540b | 206 | with the following command: |
207 | ||
208 | disorder setup-guest | |
209 | ||
210 | If you don't want to allow online registration instead use: | |
211 | ||
a767291c | 212 | disorder setup-guest --no-online-registration |
5e34540b | 213 | |
a767291c | 214 | 3. Make sure that DisOrder can find its icons and stylesheet. For example in |
215 | your web server configuration: | |
460b9539 | 216 | |
5e34540b | 217 | Alias /disorder/ /usr/local/share/disorder/static/ |
460b9539 | 218 | |
5e34540b | 219 | Alternatively you could use a symlink from the right location in your |
220 | document root, provided your web server is configured to follow them. | |
221 | ||
a767291c | 222 | cd /var/www |
223 | ln -s /usr/local/share/disorder/static disorder | |
460b9539 | 224 | |
e70701e7 | 225 | 4. Install disorder.cgi in an appropriate location. Remember to make it |
a767291c | 226 | executable. Example: |
5e34540b | 227 | |
228 | install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder | |
229 | ||
e70701e7 | 230 | 5. Try it out. You should be able to perform read-only operations straight |
d84bf422 | 231 | away, and after visiting the 'Login' page to authenticate, perform other |
232 | operations like adding a track to the queue. | |
460b9539 | 233 | |
e70701e7 | 234 | 6. If you run into problems, always look at the appropriate error log; the |
5e34540b | 235 | message you see in your web browser will usually not be sufficient to |
236 | diagnose the problem all by itself. | |
460b9539 | 237 | |
e70701e7 | 238 | 7. If you have a huge number of top level directories, then you might find |
5e34540b | 239 | that the 'Choose' page is unreasonably large. If so add the following line |
240 | to /etc/disorder/options.user: | |
241 | label sidebar.choosewhich choosealpha | |
242 | ||
243 | This will make 'Choose' be a link for each letter of the 26-letter Roman | |
244 | alphabet; follow the link and you just get the directories which start with | |
245 | that letter. The "*" link at the end gives you directories which don't | |
246 | start with a letter. | |
247 | ||
248 | You can copy choosealpha.html to /etc/disorder and edit it to change the | |
249 | set of initial choices to anything that can be expressed with regexps. The | |
250 | regexps must be URL-encoded UTF-8 PCRE regexps. | |
460b9539 | 251 | |
a767291c | 252 | If you want to give DisOrder its own virtual host, see README.vhost. |
460b9539 | 253 | |
254 | Copyright | |
255 | ========= | |
256 | ||
257 | "Nothing but another drug, a licence that you buy and sell" | |
258 | ||
259 | DisOrder - select and play digital audio files | |
eb525fcd | 260 | Copyright (C) 2003-2007 Richard Kettlewell |
313acc77 RK |
261 | Portions copyright (C) 2007 Ross Younger |
262 | Portions copyright (C) 2007 Mark Wooding | |
460b9539 | 263 | Portions extracted from MPG321, http://mpg321.sourceforge.net/ |
264 | Copyright (C) 2001 Joe Drew | |
265 | Copyright (C) 2000-2001 Robert Leslie | |
266 | Binaries may derive extra copyright owners through linkage (binary distributors | |
267 | are expected to do their own legwork) | |
268 | ||
269 | This program is free software; you can redistribute it and/or modify it under | |
270 | the terms of the GNU General Public License as published by the Free Software | |
271 | Foundation; either version 2 of the License, or (at your option) any later | |
272 | version. | |
273 | ||
274 | This program is distributed in the hope that it will be useful, but WITHOUT ANY | |
275 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | |
276 | PARTICULAR PURPOSE. See the GNU General Public License for more details. | |
277 | ||
278 | You should have received a copy of the GNU General Public License along with | |
279 | this program; if not, write to the Free Software Foundation, Inc., 59 Temple | |
280 | Place, Suite 330, Boston, MA 02111-1307 USA | |
281 | ||
282 | Local Variables: | |
283 | mode:text | |
284 | fill-column:79 | |
285 | End: |