improve READMEs a bit

[disorder] / README

diff --git a/README b/README
index 373e572..8692efa 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
 
 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
   libgc            6.8
   libvorbisfile    1.1.2
   libpcre          6.7                 need UTF-8 support


@@ -129,7 +129,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
 
    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.
 
 
 5. Make sure the server is started at boot time.
 


@@ -181,71 +183,58 @@ Web Interface
 
    "Thought I was a gonner baby, but I'm bullet proof"
 
 
    "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:
 
 
 You need to configure a number of things to make this work:
 

-1. The web interface depends on a 'guest' user existing.  You can create this
-   with the following command:
+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, deliverable email
+   address then the results are not likely to be reliable.

 
 

-     disorder setup-guest
+     mail_sender webmaster@example.com

 
 

-   If you don't want to allow online registration instead use:
+   By default the web interface sends mail by connecting to the SMTP port of
+   127.0.0.1.  You can override this with the smtp_server directive, for
+   exampler:

 
 

-     disorder -- setup-guest --no-online-registration
+     smtp_server mail.example.com

 
 

-2a. 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>
+2. The web interface depends on a 'guest' user existing.  You can create this
+   with the following command:

 
 

-   Don't forget to reload Apache after modifying its configuration.
+     disorder setup-guest

 
 

-   You must tell the web interface how to find its icons and stylesheet:
+   If you don't want to allow online registration instead use:

 
 

-     echo label url.static /static/ >> /etc/disorder/options.user
-     echo label links.css /static/disorder.css >> /etc/disorder/options.user
+     disorder setup-guest --no-online-registration

 
 

-2b. 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.
 
 
      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
-
-3. Install disorder.cgi in an appropriate location.  Remember to make it
-   executable.  For example assuming a virtual host as above (2a):
-
-     install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
+     cd /var/www
+     ln -s /usr/local/share/disorder/static disorder

 
 

-   or not (2b):
+4. Install disorder.cgi in an appropriate location.  Remember to make it
+   executable.  Example:

 
      install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder
 
 
      install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder
 

-4. Try it out.  You should be able to perform read-only operations straight
+5. Try it out.  You should be able to perform read-only operations straight

    away, and after visiting the 'Login' page to authenticate, perform other
    operations like adding a track to the queue.
 
    away, and after visiting the 'Login' page to authenticate, perform other
    operations like adding a track to the queue.
 

-5. If you run into problems, always look at the appropriate error log; the
+6. If you run into problems, always look at the appropriate error log; the

    message you see in your web browser will usually not be sufficient to
    diagnose the problem all by itself.
 
    message you see in your web browser will usually not be sufficient to
    diagnose the problem all by itself.
 

-6. If you have a huge number of top level directories, then you might find
+7. If you have a huge number of top level directories, then you might find

    that the 'Choose' page is unreasonably large.  If so add the following line
    to /etc/disorder/options.user:
      label sidebar.choosewhich choosealpha
    that the 'Choose' page is unreasonably large.  If so add the following line
    to /etc/disorder/options.user:
      label sidebar.choosewhich choosealpha


@@ -259,6 +248,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.
 
    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
 =========
 
 Copyright
 =========