Further simplify web setup.

[disorder] / README

diff --git a/README b/README
index f6872cb08f05d0faefc2b80ebe936595357fd663..a80c1ccaa4768f2445fd9aa4d6b4b78a53f7e0d1 100644 (file)
--- a/README
+++ b/README
@@ -160,8 +160,8 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
 
      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


@@ -181,112 +181,72 @@ 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. If you want to have a 'jukebox' virtual host, modify the DNS accordingly and
-   use a fragment such as this one:
+1. If you want online registration to work then you 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.

 
 

-     <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>
+     mail_sender webmaster@example.com

 
 

-   /static/ should point to the 'static' directory installed by DisOrder.  If
-   you don't want to use the name 'static' then you can change the url.static
-   label in the web interface configuration to your preferred URL; see
-   disorder_config(5) for details.
+   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:

 
 

-   Don't forget to reload Apache after modifying its configuration.
+     smtp_server mail.example.com

 
 

-   Separate logging is not required but I find it convenient.  Up to you.
+2. The web interface depends on a 'guest' user existing.  You can create this
+   with the following command:

 
 

-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:
+     disorder setup-guest

 
 

-     <Directory /home/jukebox>
-     Require valid-user
-     AuthType basic
-     AuthName jukebox
-     AuthUserFile /home/jukebox/http.users
-     </Directory>
+   If you don't want to allow online registration instead use:

 
 

-   Adjust this according to wherever you're going to install disorder.cgi and
-   its expected URL.
+     disorder setup-guest --no-online-registration

 
 

-   Don't forget to reload apache after modifying its configuration.  If you got
-   it wrong, fix it and restart Apache.
+3. Make sure that DisOrder can find its icons and stylesheet.  For example in
+   your web server configuration:

 
 

-3. Create the password file configured above.  Something like this:
+     Alias /disorder/ /usr/local/share/disorder/static/

 
 

-     # 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
+   Alternatively you could use a symlink from the right location in your
+   document root, provided your web server is configured to follow them.

 
 

-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.
+     cd /var/www
+     ln -s /usr/local/share/disorder/static disorder

 
 

-5. Install disorder.cgi in an appropriate location.  Remember to make it
-   executable.  For example:
+4. Install disorder.cgi in an appropriate location.  Remember to make it
+   executable.  Example:

 
 

-     install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
+     install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder

 
 

-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:
+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.

 
 

-     trust www-data
-     url http://jukebox.DOMAIN/
+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.

 
 

-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:
+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

 
 

-     allow www-data MYPASSWORD
+   This will make 'Choose' be a link for each letter of the 26-letter Roman
+   alphabet; follow the link and you just get the directories which start with
+   that letter.  The "*" link at the end gives you directories which don't
+   start with a letter.

 
 

-   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.
-
-10. 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.
-
-11. 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
-
-    This will make 'Choose' be a link for each letter of the 26-letter Roman
-    alphabet; follow the link and you just get the directories which start with
-    that letter.  The "*" link at the end gives you directories which don't
-    start with a letter.
-
-    You can copy choosealpha.html to /etc/disorder and edit it to change the
-    set of initial choices to anything that can be expressed with regexps.  The
-    regexps must be URL-encoded UTF-8 PCRE regexps.
+   You can copy choosealpha.html to /etc/disorder and edit it to change the
+   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
 =========