chiark / gitweb /
Further simplify web setup.
[disorder] / README
diff --git a/README b/README
index 350d7a2..a80c1cc 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,23 @@
 DisOrder
 ========
 
-This program is used to play random and chosen tracks from a collection of
-digital audio files (for instance MP3 and OGG files).  If you just set it going
-it plays random tracks from your collection, but you can also ask for specific
-tracks to be played, either via a command line program or a web interface, and
-you can 'scratch' the current track.
+DisOrder is a multi-user software jukebox.
+   * It can play either selected tracks or pick tracks at random.
+   * It supports OGG, MP3, FLAC and WAV files, and can be configured to support
+     anything you can supply a player for (up to a point).
+   * It supports both ALSA and OSS and can also broadcast an RTP stream over a
+     LAN; a player for the latter is included.
+   * Tracks may be selected either via a hierarchical interface or by a fast
+     word search.
+   * It has a web interface (allowing access from graphical web browsers) and a
+     GTK+ interface that runs on Linux and Mac systems.
+   * Playing tracks can be paused or cancelled ("scratched").
 
 See CHANGES for details of recent changes to DisOrder.
 
-Currently it only runs on Linux.  It could probably be ported to other UNIX
-variants in some cases 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
@@ -25,6 +32,7 @@ Build dependencies:
   libFLAC          1.1.2
   GNU C            4.1.2
   GNU Make         3.81
+  GNU Sed          4.1.5
   Python           2.4.4               (optional)
   GTK+             2.8.20              (if you want the GTK+ client)
   GLIB             2.12.4              (if you want the GTK+ client)
@@ -65,6 +73,9 @@ Installation
 
 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
@@ -83,16 +94,12 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
    See README.client for setting up a standalone client (or read the
    disobedience man page).
 
-   The server is only built by default under Linux.  See README.mac concerning
-   its use under OS X.
-
 2. Install it.  Most of the installation is done via the install target:
 
      make installdirs install
 
-   The CGI interface has to be installed separately:
-
-     install -m 755 clients/disorder.cgi /usr/local/lib/cgi-bin/disorder
+   The CGI interface has to be installed separately; see under 'Web Interface'
+   below.
 
 3. Create a 'jukebox' user and group, with the jukebox group being the default
    group of the jukebox user.  The server will run as this user and group.
@@ -104,49 +111,33 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
    specifically for DisOrder.
 
 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it
-   to your own requirements.  In particular, you should:
-    * add 'player' commands for any file formats not supported natively
+   to your own requirements.  The things you MUST do are:
     * edit the 'collection' command to identify the location(s) of your own
       digital audio files.  These commands also specify the encoding of
       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
     * edit the 'scratch' commands to supply scratch sounds (or delete them if
       you don't want any).
-    * edit the 'trust' command to reflect the user the web interface will
-      eventually run as.
-    * edit the 'url' command to give the URL of the web interface.
     * add or remove '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.
 
-   See README.raw for details on setting up "raw format" players, which allow
-   for pausing and gapless play.
-
-5. Create /etc/disorder/config.private.  This should be readable only by the
-   jukebox group:
+   See README.streams for how to set up network play.
 
-     touch /etc/disorder/config.private
-     chown root:jukebox /etc/disorder/config.private
-     chmod 640 /etc/disorder/config.private
+   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.
 
-   Set up a username and password for root, for example with line like this:
-
-     allow root somepassword
-
-   Use (for instance) pwgen(1) to create the password.  DO NOT use your root
-   password - this is a password to give root access to the server, not to give
-   access to the root login.
-
-   See disorderd(8) and disorder_config(5) for more details.
-
-6. Make sure the server is started at boot time.
+5. Make sure the server is started at boot time.
 
    On many Linux systems, examples/disorder.init should be more or less
    suitable; install it in /etc/init.d, adapting it as necessary, and make
    appropriate links from /etc/rc[0-6].d.
 
-7. Start the server.
+6. Start the server.
 
    On Linux systems with sysv-style init:
 
@@ -157,40 +148,32 @@ 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.
 
-8. After a minute it should start to play something.  Try scratching it, as any
-   of the users you set up in step 5:
+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.
 
-9. Add any other users you want to config.private.  Each user's password
-   should be stored in a file in their home directory, ~/.disorder/passwd,
-   which should be readable only by them, and should take the form of a single
-   line:
-
-     password MYPASSWORD
+8. Add any other users you want.  These easiest way to do this is (still as
+   root):
 
-   (root doesn't need this as the client can read it out of config.private
-   when running as root.)
+     disorder authorize USERNAME
 
-   Note that the server must be reloaded (e.g. by 'disorder reconfigure')
-   when new users are added.
+   This will automatically choose a random password and create
+   /etc/disorder/config.USERNAME.
 
-   Alternatively the administrator can create /etc/disorder/config.USERNAME
-   containing the same thing as above.  It can either be owned by the user and
-   mode 400, or owned by root and the user's group (if you have per-user
-   groups) and mode 440.
+   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
+   Disobedience from some other host, File->Login allows hostnames, passwords
+   etc to be configured.
 
-   You can use 'disorder authorize' to automatically pick passwords and
-   create these files.
+9. Optionally source completion.bash from /etc/profile or similar, for
+   example:
 
-10. Optionally source completion.bash from /etc/profile or similar, for
-    example:
+     . /usr/local/share/disorder/completion.bash
 
-      . /usr/local/share/disorder/completion.bash
-
-    This provides completion over disorder command and option names.
+   This provides completion over disorder command and option names.
 
 
 Web Interface
@@ -198,115 +181,72 @@ 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 to have a 'jukebox' virtual host, modify the DNS (or hosts file
-   if you are somehow reading this in the 1980s) 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>
-
-   /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.
-
-   Don't forget to reload Apache after modifying its configuration.
-
-   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.
-
-   Don't forget to reload apache after modifying its configuration.  If you got
-   it wrong, fix it and restart Apache.
-
-3. Create the password file configured above.  Something like this:
+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.
 
-     # 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
+     mail_sender webmaster@example.com
 
-4. The jukebox must be configured to trust the web user.  I added the following
-   line to my /etc/disorder/config:
+   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:
 
-     trust www-data
+     smtp_server mail.example.com
 
-   This might not be the same on your system!  You have to specify the user
-   that the CGI script runs as, whatever that is.
+2. The web interface depends on a 'guest' user existing.  You can create this
+   with the following command:
 
-5. Install disorder.cgi in an appropriate location.  Remember to make it
-   executable.  With the above configuration I installed it as
-   ~jukebox/public_html/index.cgi.
+     disorder setup-guest
 
-6. 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:
+   If you don't want to allow online registration instead use:
 
-     allow www-data MYPASSWORD
+     disorder setup-guest --no-online-registration
 
-   After editing the config file, you must make the daemon re-read it:
+3. Make sure that DisOrder can find its icons and stylesheet.  For example in
+   your web server configuration:
 
-     disorder reconfigure
+     Alias /disorder/ /usr/local/share/disorder/static/
 
-7. 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.
+   Alternatively you could use a symlink from the right location in your
+   document root, provided your web server is configured to follow them.
 
-     password MYPASSWORD
+     cd /var/www
+     ln -s /usr/local/share/disorder/static disorder
 
-   (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.)
+4. Install disorder.cgi in an appropriate location.  Remember to make it
+   executable.  Example:
 
-8. 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.
+     install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder
 
-9. Some features take time to start working, for instance those involving
-   reporting the length of tracks.  This is because the server starts up as
-   quickly as possible even if the full track data has not yet been gathered;
-   the track data is then calculated in the background.
+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
-    message you see in your web browser will usually not be sufficient to
-    diagnose the problem all by itself.
+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.
 
-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
+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
 
-    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.
+   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
 =========
@@ -315,6 +255,8 @@ Copyright
 
 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