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 or tag 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 and README.upgrades for
  17 upgrade instructions.
  18
  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.
  25
  26 Build dependencies:
  27   Name             Tested              Notes
  28   libdb            4.3.29              not 4.2.x; 4.4+ might work.
  29   libgc            6.8
  30   libvorbisfile    1.1.2
  31   libpcre          6.7                 need UTF-8 support
  32   libmad           0.15.1b
  33   libgcrypt        1.2.3
  34   libao            0.8.6
  35   libasound        1.0.13
  36   libFLAC          1.1.2
  37   GNU C            4.1.2
  38   GNU Make         3.81
  39   GNU Sed          4.1.5
  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)
  43
  44 "Tested" means I've built against that version; earlier or later versions will
  45 often work too.
  46
  47 For the web interface to work you will additionally need a web server.  I've
  48 had both Apache 1.3.x and 2.x working.  Anything that supports CGI should be
  49 OK.
  50
  51 Mailing 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
  57 Developers should read README.developers.
  58
  59
  60 Installation
  61 ============
  62
  63    "This place'd be a paradise tomorrow, if every department had a supervisor
  64    with a machine-gun"
  65
  66 IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
  67
  68 Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
  69 files.
  70
  71 OX X/FreeBSD/other Linux: after installation (step 1) 'sudo bash scripts/setup'
  72 covers steps 3 to 6.  If it doesn't work on your platform, please get in touch.
  73
  74 1. Build the software.  Do something like this:
  75
  76      ./configure
  77      make                   # on FreeBSD use gmake
  78
  79    See INSTALL or ./configure --help for more details about driving configure.
  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
  87    See README.client for setting up a standalone client (or read the
  88    disobedience man page).
  89
  90    To build .debs on Debian/Ubuntu, use:
  91      fakeroot debian/rules binary
  92
  93 2. Install it.  Most of the installation is done via the install target:
  94
  95      make installdirs install
  96
  97    The CGI interface has to be installed separately; see under 'Web Interface'
  98    below.
  99
 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
 103 3. 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
 112 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it
 113    to your own requirements.  The things you MUST do are:
 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).
 118    Optionally you may also want to do the following:
 119     * add 'player' and 'tracklength' commands for any file formats not
 120       supported natively
 121     * edit the 'scratch' commands to supply scratch sounds (or delete them if
 122       you don't want any).
 123     * add extra 'stopword' entries as necessary (these words won't take part in
 124       track name searches from the web interface).
 125
 126    See disorder_config(5) for more details.
 127
 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
 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.
 135
 136 5. Make sure the server is started at boot time.
 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
 142 6. Start the server.
 143
 144    On Linux systems with sysv-style init:
 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
 153 7. After a short while it should start to play something.  Try scratching it
 154    (as root):
 155
 156      disorder scratch
 157
 158    The track should stop playing, and (if you set any up) a scratch sound play.
 159
 160 8. Add any other users you want.  These easiest way to do this is (still as
 161    root):
 162
 163      disorder authorize USERNAME
 164
 165    This will automatically choose a random password and create
 166    ~USERNAME/.disorder/passwd.
 167
 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
 173    Alternatively, after setting up the web interface (below), it's possible to
 174    allow users to register themselves without operator involvement.
 175
 176 9. Optionally source completion.bash from /etc/profile or similar, for
 177    example:
 178
 179      . /usr/local/share/disorder/completion.bash
 180
 181    This provides completion over disorder command and option names.
 182
 183
 184 Web Interface
 185 =============
 186
 187    "Thought I was a gonner baby, but I'm bullet proof"
 188
 189 Debian/Ubuntu: the .deb files will do the setup here automatically.
 190
 191 OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
 192 here automatically.
 193
 194 You need to configure a number of things to make this work:
 195
 196 1. If you want online registration to work then set mail_sender in
 197    /etc/disorder/config to the email address that communications from the web
 198    interface will appear to be sent.  If this is not a valid, deliverable email
 199    address then the results are not likely to be reliable.
 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
 209    Use 'disorder reconfigure' to make sure the server knows these settings.
 210
 211 2. The web interface depends on a 'guest' user existing.  You can create this
 212    with the following command:
 213
 214      disorder setup-guest
 215
 216    If you don't want to allow online registration instead use:
 217
 218      disorder setup-guest --no-online-registration
 219
 220 3. Make sure that DisOrder can find its icons and stylesheet.  For example in
 221    your web server configuration:
 222
 223      Alias /disorder/ /usr/local/share/disorder/static/
 224
 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
 228      cd /var/www
 229      ln -s /usr/local/share/disorder/static disorder
 230
 231 4. Install disorder.cgi in an appropriate location.  Remember to make it
 232    executable.  Example:
 233
 234      install -m 755 server/disorder.cgi /usr/lib/cgi-bin/disorder
 235
 236 5. Try it out.  You should be able to perform read-only operations straight
 237    away, and after visiting the 'Login' page to authenticate, perform other
 238    operations like adding a track to the queue.
 239
 240 6. If you run into problems, always look at the appropriate error log; the
 241    message you see in your web browser will usually not be sufficient to
 242    diagnose the problem all by itself.
 243
 244 7. If you have a huge number of top level directories, then you might find
 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.
 257
 258 If you want to give DisOrder its own virtual host, see README.vhost.
 259
 260 Copyright
 261 =========
 262
 263   "Nothing but another drug, a licence that you buy and sell"
 264
 265 DisOrder - select and play digital audio files
 266 Copyright (C) 2003-2008 Richard Kettlewell
 267 Portions copyright (C) 2007 Ross Younger
 268 Portions copyright (C) 2007 Mark Wooding
 269 Portions extracted from MPG321, http://mpg321.sourceforge.net/
 270   Copyright (C) 2001 Joe Drew
 271   Copyright (C) 2000-2001 Robert Leslie
 272 Binaries may derive extra copyright owners through linkage (binary distributors
 273 are expected to do their own legwork)
 274
 275 This program is free software; you can redistribute it and/or modify it under
 276 the terms of the GNU General Public License as published by the Free Software
 277 Foundation; either version 2 of the License, or (at your option) any later
 278 version.
 279
 280 This program is distributed in the hope that it will be useful, but WITHOUT ANY
 281 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 282 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 283
 284 You should have received a copy of the GNU General Public License along with
 285 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 286 Place, Suite 330, Boston, MA 02111-1307 USA
 287
 288 Local Variables:
 289 mode:text
 290 fill-column:79
 291 End: