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