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