chiark / gitweb /
automatically create the home directory on startup
[disorder] / README
diff --git a/README b/README
index edc30659dc952f53e58421dbabc588c21d7d6f8b..350d7a274a5accb57417eca6fb9a9a11994c09d6 100644 (file)
--- a/README
+++ b/README
@@ -14,37 +14,41 @@ variants in some cases without too much effort.  Things you will need:
 
 Build dependencies:
   Name             Tested              Notes
-  libdb            4.3.21              4.2 and earlier won't work
-  libgc            6.3
-  libvorbisfile    1.0.1
-  libpcre          4.5                 need UTF-8 support
+  libdb            4.3.29              4.2 and earlier won't work
+  libgc            6.8
+  libvorbisfile    1.1.2
+  libpcre          6.7                 need UTF-8 support
   libmad           0.15.1b
-  libgcrypt        1.2.0
+  libgcrypt        1.2.3
   libao            0.8.6
-  libasound        1.0.8
-  Python           2.3                 (optional)
-  GNU C            3.3, 3.4
+  libasound        1.0.13
+  libFLAC          1.1.2
+  GNU C            4.1.2
+  GNU Make         3.81
+  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)
 
 "Tested" means I've built against that version; earlier or later versions will
 often work too.
 
 Runtime dependencies:
- * Players:
-   + ogg123 and mpg321 work for me, but you could potentially use others.
  * 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)
 
 Development dependencies (only developers will need these):
-  Automake         1.9.4               AM_PATH_PYTHON not good enough in 1.7
-  Autoconf         2.59
-  Libtool          1.5.              1.4 not good enough
+  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 libdb-dev
+                  libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
+                  libflac-dev
 
 Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
@@ -76,21 +80,19 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
      --without-gtk          Don't build GTK+ client (Disobedience)
      --without-python       Don't build Python support
 
-   See README.client for setting up a standalone client.
+   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, and you must use Libtool
-   to install it.  For instance:
-
-     ./libtool --mode=install install -m 755 progs/disorder.cgi /usr/local/lib/cgi-bin/disorder
-
-   Depending on how your system is configured you may need to link the disorder
-   libao driver into the right directory:
+   The CGI interface has to be installed separately:
 
-     ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
+     install -m 755 clients/disorder.cgi /usr/local/lib/cgi-bin/disorder
 
 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.
@@ -103,7 +105,7 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
 
 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it
    to your own requirements.  In particular, you should:
-    * edit the 'player' commands to reflect the software you have installed.
+    * add 'player' commands for any file formats not supported natively
     * 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
@@ -118,6 +120,9 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
 
    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:
 
@@ -135,18 +140,15 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
 
    See disorderd(8) and disorder_config(5) for more details.
 
-6. 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.  If you have a BSD style init then you are on your own.
+6. Make sure the server is started at boot time.
 
-7. Make sure the state directory (/var/disorder or /usr/local/var/disorder or
-   as determined by configure) exists and is writable by the jukebox user.
+   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.
 
-     mkdir -m 755 /var/disorder
-     chown disorder:root /var/disorder
+7. Start the server.
 
-8. Start the server, for instance:
+   On Linux systems with sysv-style init:
 
      /etc/init.d/disorder start
 
@@ -155,35 +157,35 @@ 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.
 
-9. After a minute it should start to play something.  Try scratching it, as any
+8. After a minute it should start to play something.  Try scratching it, as any
    of the users you set up in step 5:
 
      disorder scratch
 
    The track should stop playing, and (if you set any up) a scratch sound play.
 
-10. 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:
+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
+     password MYPASSWORD
 
-    (root doesn't need this as the client can read it out of config.private
-    when running as root.)
+   (root doesn't need this as the client can read it out of config.private
+   when running as root.)
 
-    Note that the server must be reloaded (e.g. by 'disorder reconfigure')
-    when new users are added.
+   Note that the server must be reloaded (e.g. by 'disorder reconfigure')
+   when new users are added.
 
-    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.
+   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.
 
-    You can use 'disorder authorize' to automatically pick passwords and
-    create these files.
+   You can use 'disorder authorize' to automatically pick passwords and
+   create these files.
 
-11. Optionally source completion.bash from /etc/profile or similar, for
+10. Optionally source completion.bash from /etc/profile or similar, for
     example:
 
       . /usr/local/share/disorder/completion.bash