chiark / gitweb /
New 'new_max' configuration bounds the number of tracks that 'new'
[disorder] / README
diff --git a/README b/README
index c0b3dd7a8e0a27239ccbaaabf6340e73b549e352..11bbbb047f70d0c1e0ce8eba1f65b852f11d5e94 100644 (file)
--- a/README
+++ b/README
@@ -21,7 +21,7 @@ some other UNIX variants without too much effort.  Things you will need:
 
 Build dependencies:
   Name             Tested              Notes
-  libdb            4.3.29              4.2 and earlier won't work
+  libdb            4.3.29              not 4.2.x; 4.4+ might work.
   libgc            6.8
   libvorbisfile    1.1.2
   libpcre          6.7                 need UTF-8 support
@@ -117,11 +117,12 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
       filenames, which you should be sure to get right as recovery from an
       error here can be painful (see BUGS).
    Optionally you may also want to do the following:
-    * add 'player' commands for any file formats not supported natively
+    * add 'player' and 'tracklength' commands for any file formats not
+      supported natively
     * edit the 'scratch' commands to supply scratch sounds (or delete them if
       you don't want any).
-    * add or remove 'stopword' entries as necessary (these words won't take
-      part in track name searches from the web interface).
+    * add extra 'stopword' entries as necessary (these words won't take part in
+      track name searches from the web interface).
 
    See disorder_config(5) for more details.
 
@@ -129,7 +130,9 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
 
    If adding new 'player' commands, see README.raw for details on setting up
    "raw format" players.  Non-raw players are still supported but not in all
-   configurations and they cannot support pausing and gapless play.
+   configurations and they cannot support pausing and gapless play.  If you
+   want additional formats to be supported natively please point the author at
+   a GPL-compatible library that can decode them.
 
 5. Make sure the server is started at boot time.
 
@@ -148,8 +151,8 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
    start up correctly there should be an error message.  Correct the problem
    and try again.
 
-7. After a minute it should start to play something.  Try scratching it (as
-   root):
+7. After a short while it should start to play something.  Try scratching it
+   (as root):
 
      disorder scratch
 
@@ -181,14 +184,15 @@ Web Interface
 
    "Thought I was a gonner baby, but I'm bullet proof"
 
-These instructions assumes you are using Apache 1.3.x.
+As above, if you install from a .deb, much of the work will be done
+automatically.
 
 You need to configure a number of things to make this work:
 
-1. If you want online registration to work then you set mail_sender in
+1. If you want online registration to work then set mail_sender in
    /etc/disorder/config to the email address that communications from the web
-   interface will appear to be sent.  If this is not a valid, deliberable email
-   address then the results are not likely to reliable.
+   interface will appear to be sent.  If this is not a valid, deliverable email
+   address then the results are not likely to be reliable.
 
      mail_sender webmaster@example.com
 
@@ -205,48 +209,21 @@ You need to configure a number of things to make this work:
 
    If you don't want to allow online registration instead use:
 
-     disorder -- setup-guest --no-online-registration
-
-3a. If you want to have a 'jukebox' virtual host, modify the DNS accordingly
-    and use a fragment such as this one:
-
-     <VirtualHost HOSTNAME>
-     DocumentRoot /home/jukebox/public_html
-     ServerName jukebox.DOMAIN
-     ServerAlias jukebox
-     ServerAdmin webmaster@DOMAIN
-     ErrorLog /var/log/apache/jukebox/error.log
-     TransferLog /var/log/apache/jukebox/access.log
-     Alias /static/ /usr/local/share/disorder/static/
-     </VirtualHost>
-
-   Don't forget to reload Apache after modifying its configuration.
-
-   You must tell the web interface how to find its icons and stylesheet:
+     disorder setup-guest --no-online-registration
 
-     echo label url.static /static/ >> /etc/disorder/options.user
-     echo label links.css /static/disorder.css >> /etc/disorder/options.user
-
-3b. If you don't want a virtual host then you must still make sure that
-    DisOrder can find its icons and stylesheet.  For example in your web server
-    configuration:
+3. Make sure that DisOrder can find its icons and stylesheet.  For example in
+   your web server configuration:
 
      Alias /disorder/ /usr/local/share/disorder/static/
 
    Alternatively you could use a symlink from the right location in your
    document root, provided your web server is configured to follow them.
 
-   Also you must tell the web interface how to find them:
-
-     echo label url.static /disorder/ >> /etc/disorder/options.user
-     echo label links.css /disorder/disorder.css >> /etc/disorder/options.user
+     cd /var/www
+     ln -s /usr/local/share/disorder/static disorder
 
 4. Install disorder.cgi in an appropriate location.  Remember to make it
-   executable.  For example assuming a virtual host as above (3a):
-
-     install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
-
-   or not (3b):
+   executable.  Example:
 
      install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder
 
@@ -272,6 +249,7 @@ You need to configure a number of things to make this work:
    set of initial choices to anything that can be expressed with regexps.  The
    regexps must be URL-encoded UTF-8 PCRE regexps.
 
+If you want to give DisOrder its own virtual host, see README.vhost.
 
 Copyright
 =========
@@ -279,7 +257,7 @@ Copyright
   "Nothing but another drug, a licence that you buy and sell"
 
 DisOrder - select and play digital audio files
-Copyright (C) 2003-2007 Richard Kettlewell
+Copyright (C) 2003-2008 Richard Kettlewell
 Portions copyright (C) 2007 Ross Younger
 Portions copyright (C) 2007 Mark Wooding
 Portions extracted from MPG321, http://mpg321.sourceforge.net/