chiark / gitweb /
Disobedience notices when tracks are adopted now.
[disorder] / README
diff --git a/README b/README
index f6872cb..c69cf4c 100644 (file)
--- a/README
+++ b/README
@@ -8,20 +8,24 @@ DisOrder is a multi-user software jukebox.
    * 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.
+     word or tag 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.
+See CHANGES.html for details of recent changes to DisOrder and README.upgrades
+for upgrade instructions.
 
-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:
+Platform support:
+  Linux            Well tested on Debian
+  Mac OS X         Disobedience well tested, server somewhat tested; use fink
+  FreeBSD          Scantily tested; use ports for dependencies
+It could probably be ported to some other UNIX variants without too much
+effort.
 
 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-4.6 seem to work too
   libgc            6.8
   libvorbisfile    1.1.2
   libpcre          6.7                 need UTF-8 support
@@ -30,9 +34,9 @@ Build dependencies:
   libao            0.8.6
   libasound        1.0.13
   libFLAC          1.1.2
-  GNU C            4.1.2
-  GNU Make         3.81
-  GNU Sed          4.1.5
+  GNU C            4.1.2               }
+  GNU Make         3.81                } Non-GNU versions will NOT work
+  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)
@@ -40,23 +44,12 @@ Build dependencies:
 "Tested" means I've built against that version; earlier or later versions will
 often work too.
 
-Runtime dependencies:
- * Web server:
-   + Apache 1.3.x works for me, but anything that supports CGI and
-     authentication should be suitable.
- * Separate player programs are no longer required (but may still be used)
+For the web interface to work you will additionally need a web server.  I've
+had both Apache 1.3.x and 2.x working.  Anything that supports CGI should be
+OK.
 
-Development dependencies (only developers will need these):
-  Automake         1.10                AM_PATH_PYTHON not good enough in 1.7
-  Autoconf         2.61
-  Libtool          1.5.22              1.4 not good enough
-  Bazaar (bzr)
-
-On Debian you might ensure you have the required packages as follows:
-  apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
-                  libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
-                  libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
-                  libflac-dev
+Bug tracker, etc:
+  http://code.google.com/p/disorder/
 
 Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
@@ -64,6 +57,8 @@ Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
    - announcements of new versions of DisOrder
 
+Developers should read README.developers.
+
 
 Installation
 ============
@@ -71,19 +66,21 @@ Installation
    "This place'd be a paradise tomorrow, if every department had a supervisor
    with a machine-gun"
 
-NOTE: If you are upgrading from an earlier version, see README.upgrades.
+IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
+
+Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
+files.
 
-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!
+OX X/FreeBSD/other Linux: after installation (step 1 and 2), running
+'sudo bash scripts/setup' will cover steps 3 to 6.  If it doesn't work on your
+platform, please get in touch.
 
 1. Build the software.  Do something like this:
 
-     ./configure --sysconfdir=/etc --localstatedir=/var
-     make
+     ./configure
+     make                   # on FreeBSD use gmake
 
-   See INSTALL for more details about driving configure.  The precise set of
-   options you pass to configure is up to you, if you like configuration being
-   in /usr/local/etc or wherever then that should work.
+   See INSTALL or ./configure --help for more details about driving configure.
 
    If you only want to build a subset of DisOrder, specify one or more of the
    following options:
@@ -91,15 +88,23 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
      --without-gtk          Don't build GTK+ client (Disobedience)
      --without-python       Don't build Python support
 
+   If configure cannot guess where your web server keeps its HTML documents and
+   CGI programs, you may have to tell it, for instance:
+
+     ./configure cgiexecdir=/whatever/cgi-bin httpdir=/whatever/htdocs
+
    See README.client for setting up a standalone client (or read the
    disobedience man page).
 
+   To build .debs on Debian/Ubuntu, use:
+     fakeroot debian/rules binary
+
 2. Install it.  Most of the installation is done via the install target:
 
      make installdirs install
 
-   The CGI interface has to be installed separately; see under 'Web Interface'
-   below.
+   NB steps 3 to 6 are covered by scripts/setup.  It should work on FreeBSD, OS
+   X and Linux and could be adapted to other platforms.
 
 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.
@@ -117,11 +122,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 +135,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 +156,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
 
@@ -160,14 +168,17 @@ skip steps 1 to 6 and configure it via debconf.  This is strongly recommended!
 
      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
+   ~USERNAME/.disorder/passwd.
 
    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.
 
+   Alternatively, after setting up the web interface (below), it's possible to
+   allow users to register themselves without operator involvement.
+
 9. Optionally source completion.bash from /etc/profile or similar, for
    example:
 
@@ -181,112 +192,70 @@ Web Interface
 
    "Thought I was a gonner baby, but I'm bullet proof"
 
-These instructions assumes you are using Apache 1.3.x.
-
-You need to configure a number of things to make this work:
+Debian/Ubuntu: the .deb files will do the setup here automatically.
 
-1. If you want to have a 'jukebox' virtual host, modify the DNS accordingly and
-   use a fragment such as this one:
+OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
+here automatically.
 
-     <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:
+You need to configure a number of things to make this work:
 
-     # 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
+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.
 
-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.
+     mail_sender webmaster@example.com
 
-5. Install disorder.cgi in an appropriate location.  Remember to make it
-   executable.  For example:
+   By default the web interface sends mail via the system sendmail executable
+   (typically /usr/sbin/sendmail or /usr/lib/sendmail).  You can override this
+   with the sendmail directive, for example:
 
-     install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
+     sendmail /usr/sbin/my-sendmail
 
-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:
+   The executable you choose must support the -bs option.  Alternatively you
+   can tell it to connect to an SMTP server via TCP, with the smtp_server
+   directive.  For example:
 
-     trust www-data
-     url http://jukebox.DOMAIN/
+     smtp_server mail.example.com
 
-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:
+   Use 'disorder reconfigure' to make sure the server knows these settings.
 
-     allow www-data MYPASSWORD
+2. The web interface depends on a 'guest' user existing.  You can create this
+   with the following command:
 
-   After editing the config file, you must make the daemon re-read it:
+     disorder setup-guest
 
-     disorder reconfigure
+   If you don't want to allow online registration instead use:
 
-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.
+     disorder setup-guest --no-online-registration
 
-     password MYPASSWORD
+3. Try it out.  The url will be (something like):
 
-   (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!)
+     http://localhost/cgi-bin/disorder
 
-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.
+   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.
+4. 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
+5. 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
 =========
@@ -294,27 +263,28 @@ 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/
   Copyright (C) 2001 Joe Drew
   Copyright (C) 2000-2001 Robert Leslie
+Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
 Binaries may derive extra copyright owners through linkage (binary distributors
 are expected to do their own legwork)
 
-This program is free software; you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free Software
-Foundation; either version 2 of the License, or (at your option) any later
-version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with
-this program; if not, write to the Free Software Foundation, Inc., 59 Temple
-Place, Suite 330, Boston, MA 02111-1307 USA
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 Local Variables:
 mode:text