some docs catchup for web interface changes

[disorder] / README

diff --git a/README b/README
index b61ac7a22252301c028043ad4de9b189c355c377..e62945d04ef850dd7fde26795d6672ff9caa32f1 100644 (file)
--- a/README
+++ b/README
@@ -15,9 +15,9 @@ DisOrder is a multi-user software jukebox.
 
 See CHANGES for details of recent changes to DisOrder.
 
 
 See CHANGES for details of recent changes to DisOrder.
 

-The server supports Linux and can be made to on a Mac (see README.mac).  The
-clients work on both Linux and the Mac.  It could probably be ported to some
-other UNIX variants without too much effort.  Things you will need:
+The server supports Linux and can be made to work on a Mac (see README.mac).
+The clients work on both Linux and the Mac.  It could probably be ported to
+some other UNIX variants without too much effort.  Things you will need:

 
 Build dependencies:
   Name             Tested              Notes
 
 Build dependencies:
   Name             Tested              Notes


@@ -73,6 +73,9 @@ Installation
 
 NOTE: If you are upgrading from an earlier version, see README.upgrades.
 
 
 NOTE: If you are upgrading from an earlier version, see README.upgrades.
 

+On a Debian system, if you install from .deb files then you should be able to
+skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
+

 1. Build the software.  Do something like this:
 
      ./configure --sysconfdir=/etc --localstatedir=/var
 1. Build the software.  Do something like this:
 
      ./configure --sysconfdir=/etc --localstatedir=/var


@@ -145,18 +148,20 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
    start up correctly there should be an error message.  Correct the problem
    and try again.
 
    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:
+7. After a minute it should start to play something.  Try scratching it (as
+   root):

 
      disorder scratch
 
    The track should stop playing, and (if you set any up) a scratch sound play.
 
 
      disorder scratch
 
    The track should stop playing, and (if you set any up) a scratch sound play.
 

-8. Add any other users you want.  These easiest way to do this is:
+8. Add any other users you want.  These easiest way to do this is (still as
+   root):

 
      disorder authorize USERNAME
 
 
      disorder authorize USERNAME
 

-   This will automatically choose a random password and add new line to
-   /etc/disorder/config.private and create /etc/disorder/config.USERNAME.
+   This will automatically choose a random password and create
+   /etc/disorder/config.USERNAME.

 
    Those users should now be able to access the server from the same host as it
    runs on, either via the disorder command or Disobedience.  To run
 
    Those users should now be able to access the server from the same host as it
    runs on, either via the disorder command or Disobedience.  To run


@@ -202,73 +207,33 @@ You need to configure a number of things to make this work:
 
    Separate logging is not required but I find it convenient.  Up to you.
 
 
    Separate logging is not required but I find it convenient.  Up to you.
 

-2. disorder.cgi assumes it is subject to access control (and in particular uses
-   the username to report who did what).  Here's how I configured Apache, given
-   the above VirtualHost settings:
-
-     <Directory /home/jukebox>
-     Require valid-user
-     AuthType basic
-     AuthName jukebox
-     AuthUserFile /home/jukebox/http.users
-     </Directory>
-
-   Adjust this according to wherever you're going to install disorder.cgi and
-   its expected URL.
+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.  If you got
-   it wrong, fix it and restart Apache.
+     disorder setup-guest

 
 

-3. Create the password file configured above.  Something like this:
+   If you don't want to allow online registration instead use:

 
 

-     # htpasswd -b -c /home/jukebox/http.users myusername mypassword
-     Adding password for user myusername
-     # htpasswd -b /home/jukebox/http.users othername otherpass
-     Adding password for user othername
+     disorder -- setup-guest --no-online-registration

 
 

-4. The jukebox must be configured to trust the web user.  The example
-   configuration assumes that this is www-data, but it might be something else
-   on your system.  Edit the 'trust' line if necessary.
-
-5. Install disorder.cgi in an appropriate location.  Remember to make it
+3. Install disorder.cgi in an appropriate location.  Remember to make it

    executable.  For example:
 
      install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
 
    executable.  For example:
 
      install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
 

-6. The config file must also allow the web interface to be any user, and it
-   must list the URL of the web interface explicitly:
+4. The config file must list the URL of the web interface explicitly:

 
 

-     trust www-data

      url http://jukebox.DOMAIN/
 
      url http://jukebox.DOMAIN/
 

-7. Give www-data (or whatever user it is) a password and edit
-   /etc/disorder/config.private accordingly.  This file should be mode 640 and
-   owned by root:jukebox.  The line should look something like this:
-
-     allow www-data MYPASSWORD
-
-   After editing the config file, you must make the daemon re-read it:
-
-     disorder reconfigure
-
-8. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
-   This file should be mode 640 and owned by root:www-data.
-
-     password MYPASSWORD
-
-   (You could also use ~www-data/.disorder/passwd for this but on some systems
-   the web server user's home directory is inside the document root, which
-   would have rather unfortunate consequences!)
-
-9. Try it out.  You should be asked for a username and password that you
-   configured earlier, and be shown details of what is playing and what other
-   tracks have been configured for future play.
+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.

 
 

-10. 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.
 

-11. 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


@@ -290,6 +255,8 @@ Copyright
 
 DisOrder - select and play digital audio files
 Copyright (C) 2003-2007 Richard Kettlewell
 
 DisOrder - select and play digital audio files
 Copyright (C) 2003-2007 Richard Kettlewell

+Portions copyright (C) 2007 Ross Younger
+Portions copyright (C) 2007 Mark Wooding

 Portions extracted from MPG321, http://mpg321.sourceforge.net/
   Copyright (C) 2001 Joe Drew
   Copyright (C) 2000-2001 Robert Leslie
 Portions extracted from MPG321, http://mpg321.sourceforge.net/
   Copyright (C) 2001 Joe Drew
   Copyright (C) 2000-2001 Robert Leslie