chiark - git - mdw - disorder/blob - README

   1 DisOrder
   2 ========
   3
   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").
  15
  16 See CHANGES for details of recent changes to DisOrder.
  17
  18 The server supports Linux and can be made to on a Mac (see README.mac).  The
  19 clients work on both Linux and the Mac.  It could probably be ported to some
  20 other UNIX variants without too much effort.  Things you will need:
  21
  22 Build dependencies:
  23   Name             Tested              Notes
  24   libdb            4.3.29              4.2 and earlier won't work
  25   libgc            6.8
  26   libvorbisfile    1.1.2
  27   libpcre          6.7                 need UTF-8 support
  28   libmad           0.15.1b
  29   libgcrypt        1.2.3
  30   libao            0.8.6
  31   libasound        1.0.13
  32   libFLAC          1.1.2
  33   GNU C            4.1.2
  34   GNU Make         3.81
  35   GNU Sed          4.1.5
  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)
  39
  40 "Tested" means I've built against that version; earlier or later versions will
  41 often work too.
  42
  43 Runtime dependencies:
  44  * Web server:
  45    + Apache 1.3.x works for me, but anything that supports CGI and
  46      authentication should be suitable.
  47  * Separate player programs are no longer required (but may still be used)
  48
  49 Development dependencies (only developers will need these):
  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
  53   Bazaar (bzr)
  54
  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 \
  58                   libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
  59                   libflac-dev
  60
  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
  76 1. Build the software.  Do something like this:
  77
  78      ./configure --sysconfdir=/etc --localstatedir=/var
  79      make
  80
  81    See INSTALL for more details about driving configure.  The precise set of
  82    options you pass to configure is up to you, if you like configuration being
  83    in /usr/local/etc or wherever then that should work.
  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
  91    See README.client for setting up a standalone client (or read the
  92    disobedience man page).
  93
  94 2. Install it.  Most of the installation is done via the install target:
  95
  96      make installdirs install
  97
  98    The CGI interface has to be installed separately; see under 'Web Interface'
  99    below.
 100
 101 3. Create a 'jukebox' user and group, with the jukebox group being the default
 102    group of the jukebox user.  The server will run as this user and group.
 103    Check that this user can read your music files and write to the audio
 104    device, e.g. by playing a track.  The exact name doesn't matter, it could be
 105    'jukebox' or 'disorder' or 'fred' or whatever.
 106
 107    Do not use a general-purpose user or group, you must create ones
 108    specifically for DisOrder.
 109
 110 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it
 111    to your own requirements.  The things you MUST do are:
 112     * edit the 'collection' command to identify the location(s) of your own
 113       digital audio files.  These commands also specify the encoding of
 114       filenames, which you should be sure to get right as recovery from an
 115       error here can be painful (see BUGS).
 116    Optionally you may also want to do the following:
 117     * add 'player' commands for any file formats not supported natively
 118     * edit the 'scratch' commands to supply scratch sounds (or delete them if
 119       you don't want any).
 120     * add or remove 'stopword' entries as necessary (these words won't take
 121       part in track name searches from the web interface).
 122
 123    See disorder_config(5) for more details.
 124
 125    See README.streams for how to set up network play.
 126
 127    If adding new 'player' commands, see README.raw for details on setting up
 128    "raw format" players.  Non-raw players are still supported but not in all
 129    configurations and they cannot support pausing and gapless play.
 130
 131 5. Make sure the server is started at boot time.
 132
 133    On many Linux systems, examples/disorder.init should be more or less
 134    suitable; install it in /etc/init.d, adapting it as necessary, and make
 135    appropriate links from /etc/rc[0-6].d.
 136
 137 6. Start the server.
 138
 139    On Linux systems with sysv-style init:
 140
 141      /etc/init.d/disorder start
 142
 143    By default disorderd logs to daemon.*; check your syslog.conf to see where
 144    this ends up and look for log messages from disorderd there.  If it didn't
 145    start up correctly there should be an error message.  Correct the problem
 146    and try again.
 147
 148 7. After a minute it should start to play something.  Try scratching it:
 149
 150      disorder scratch
 151
 152    The track should stop playing, and (if you set any up) a scratch sound play.
 153
 154 8. Add any other users you want.  These easiest way to do this is:
 155
 156      disorder authorize USERNAME
 157
 158    This will automatically choose a random password and add new line to
 159    /etc/disorder/config.private and create /etc/disorder/config.USERNAME.
 160
 161    Those users should now be able to access the server from the same host as it
 162    runs on, either via the disorder command or Disobedience.  To run
 163    Disobedience from some other host, File->Login allows hostnames, passwords
 164    etc to be configured.
 165
 166 9. Optionally source completion.bash from /etc/profile or similar, for
 167    example:
 168
 169      . /usr/local/share/disorder/completion.bash
 170
 171    This provides completion over disorder command and option names.
 172
 173
 174 Web Interface
 175 =============
 176
 177    "Thought I was a gonner baby, but I'm bullet proof"
 178
 179 These instructions assumes you are using Apache 1.3.x.
 180
 181 You need to configure a number of things to make this work:
 182
 183 1. If you want to have a 'jukebox' virtual host, modify the DNS accordingly and
 184    use a fragment such as this one:
 185
 186      <VirtualHost HOSTNAME>
 187      DocumentRoot /home/jukebox/public_html
 188      ServerName jukebox.DOMAIN
 189      ServerAlias jukebox
 190      ServerAdmin webmaster@DOMAIN
 191      ErrorLog /var/log/apache/jukebox/error.log
 192      TransferLog /var/log/apache/jukebox/access.log
 193      Alias /static/ /usr/local/share/disorder/static/
 194      </VirtualHost>
 195
 196    /static/ should point to the 'static' directory installed by DisOrder.  If
 197    you don't want to use the name 'static' then you can change the url.static
 198    label in the web interface configuration to your preferred URL; see
 199    disorder_config(5) for details.
 200
 201    Don't forget to reload Apache after modifying its configuration.
 202
 203    Separate logging is not required but I find it convenient.  Up to you.
 204
 205 2. disorder.cgi assumes it is subject to access control (and in particular uses
 206    the username to report who did what).  Here's how I configured Apache, given
 207    the above VirtualHost settings:
 208
 209      <Directory /home/jukebox>
 210      Require valid-user
 211      AuthType basic
 212      AuthName jukebox
 213      AuthUserFile /home/jukebox/http.users
 214      </Directory>
 215
 216    Adjust this according to wherever you're going to install disorder.cgi and
 217    its expected URL.
 218
 219    Don't forget to reload apache after modifying its configuration.  If you got
 220    it wrong, fix it and restart Apache.
 221
 222 3. Create the password file configured above.  Something like this:
 223
 224      # htpasswd -b -c /home/jukebox/http.users myusername mypassword
 225      Adding password for user myusername
 226      # htpasswd -b /home/jukebox/http.users othername otherpass
 227      Adding password for user othername
 228
 229 4. The jukebox must be configured to trust the web user.  The example
 230    configuration assumes that this is www-data, but it might be something else
 231    on your system.  Edit the 'trust' line if necessary.
 232
 233 5. Install disorder.cgi in an appropriate location.  Remember to make it
 234    executable.  For example:
 235
 236      install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
 237
 238 6. The config file must also allow the web interface to be any user, and it
 239    must list the URL of the web interface explicitly:
 240
 241      trust www-data
 242      url http://jukebox.DOMAIN/
 243
 244 7. Give www-data (or whatever user it is) a password and edit
 245    /etc/disorder/config.private accordingly.  This file should be mode 640 and
 246    owned by root:jukebox.  The line should look something like this:
 247
 248      allow www-data MYPASSWORD
 249
 250    After editing the config file, you must make the daemon re-read it:
 251
 252      disorder reconfigure
 253
 254 8. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
 255    This file should be mode 640 and owned by root:www-data.
 256
 257      password MYPASSWORD
 258
 259    (You could also use ~www-data/.disorder/passwd for this but on some systems
 260    the web server user's home directory is inside the document root, which
 261    would have rather unfortunate consequences!)
 262
 263 9. Try it out.  You should be asked for a username and password that you
 264    configured earlier, and be shown details of what is playing and what other
 265    tracks have been configured for future play.
 266
 267 10. If you run into problems, always look at the appropriate error log; the
 268     message you see in your web browser will usually not be sufficient to
 269     diagnose the problem all by itself.
 270
 271 11. If you have a huge number of top level directories, then you might find
 272     that the 'Choose' page is unreasonably large.  If so add the following line
 273     to /etc/disorder/options.user:
 274       label sidebar.choosewhich choosealpha
 275
 276     This will make 'Choose' be a link for each letter of the 26-letter Roman
 277     alphabet; follow the link and you just get the directories which start with
 278     that letter.  The "*" link at the end gives you directories which don't
 279     start with a letter.
 280
 281     You can copy choosealpha.html to /etc/disorder and edit it to change the
 282     set of initial choices to anything that can be expressed with regexps.  The
 283     regexps must be URL-encoded UTF-8 PCRE regexps.
 284
 285
 286 Copyright
 287 =========
 288
 289   "Nothing but another drug, a licence that you buy and sell"
 290
 291 DisOrder - select and play digital audio files
 292 Copyright (C) 2003-2007 Richard Kettlewell
 293 Portions extracted from MPG321, http://mpg321.sourceforge.net/
 294   Copyright (C) 2001 Joe Drew
 295   Copyright (C) 2000-2001 Robert Leslie
 296 Binaries may derive extra copyright owners through linkage (binary distributors
 297 are expected to do their own legwork)
 298
 299 This program is free software; you can redistribute it and/or modify it under
 300 the terms of the GNU General Public License as published by the Free Software
 301 Foundation; either version 2 of the License, or (at your option) any later
 302 version.
 303
 304 This program is distributed in the hope that it will be useful, but WITHOUT ANY
 305 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 306 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 307
 308 You should have received a copy of the GNU General Public License along with
 309 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 310 Place, Suite 330, Boston, MA 02111-1307 USA
 311
 312 Local Variables:
 313 mode:text
 314 fill-column:79
 315 End: