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