chiark / gitweb /
update README* and CHANGES
authorRichard Kettlewell <rjk@greenend.org.uk>
Fri, 23 Nov 2007 17:41:24 +0000 (17:41 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Fri, 23 Nov 2007 17:41:24 +0000 (17:41 +0000)
CHANGES
README
README.mac

diff --git a/CHANGES b/CHANGES
index 0ab3194..0209e01 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -12,6 +12,10 @@ documentation for any interface) as well as by word search.  It is
 possible to limit random play by tag (see required-tags and
 prohibited-tags in disorder_config(5)).
 
+Unicode support is improved.  Case-folding and word breaking now follows
+the rules given in the Unicode standard (with a bit of tailoring in the
+latte case).
+
 ** Disobedience
 
 There is a new client, 'Disobedience', that depends on the GTK+ library.
@@ -22,6 +26,9 @@ Feedback on the interface would be very welcome.
 The "New" screen display tracks recently added to the database.  From
 here they can be played or their preferences changed.
 
+Long track names are truncated so they fit better on the screen.  Hover
+for the full name.
+
 ** Network Play
 
 DisOrder can broadcast audio over a network, allowing it to be played on
@@ -29,11 +36,8 @@ multiple client machines.  See README.streams for details.
 
 ** Server
 
-Cache slow file lookups in the server.  Should help installations with
-large collections and/or slow platforms.
-
-The communications protocol has changed, for the benefit of
-Disobedience.
+Slow file lookups are cached in the server.  This should help
+installations with large collections and/or slow platforms.
 
 The 'enabled' and 'random_enabled' configuration options are now gone.
 Instead the state survives from one run of the server to the next.
@@ -44,6 +48,8 @@ The 'pick' plugin has been abolished.  All the logic formerly done there
 is now built into the server, where it can be done much more
 efficiently.
 
+'tracklength' plugins must be explicitly specified.
+
 A bug where removing a collection (from the configuration) could cause a
 crash when random play was enabled has been fixed.
 
@@ -53,6 +59,9 @@ tracks kept on the queue to be controlled.
 There is a new utility disorder-decode which can decode OGG, MP3, WAV
 and FLAC.  The example config file uses it.
 
+Database statistics are computed in a subprocess so that the main server
+(and all clients) are not blocked for the duration.
+
 ** disorderfm
 
 There is a new command line tool called 'disorderfm' which is designed
diff --git a/README b/README
index 060c8b8..ec5b97f 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.
 
-The server supports Linux and can be made to on a Mac.  The clients work on
-both Linux and the Mac.  It could probably be ported to some other UNIX
-variants in without too much effort.  Things you will need:
+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:
 
 Build dependencies:
   Name             Tested              Notes
@@ -91,16 +91,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.
@@ -230,17 +226,14 @@ You need to configure a number of things to make this work:
      # htpasswd -b /home/jukebox/http.users othername otherpass
      Adding password for user othername
 
-4. The jukebox must be configured to trust the web user.  I added the following
-   line to my /etc/disorder/config:
-
-     trust www-data
-
-   This might not be the same on your system!  You have to specify the user
-   that the CGI script runs as, whatever that is.
+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
-   executable.  With the above configuration I installed it as
-   ~jukebox/public_html/index.cgi.
+   executable.  For example:
+
+     install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
 
 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
@@ -265,16 +258,11 @@ You need to configure a number of things to make this work:
    configured earlier, and be shown details of what is playing and what other
    tracks have been configured for future play.
 
-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.
-
-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.
+9. 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
+10. 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
index 6ccbf6a..8f93dbf 100644 (file)
@@ -7,8 +7,6 @@ Please report successes and failures!
 
 Things you will need to do:
 
-configure with --with-server.
-
 Make sure that ~jukebox/Library/Logs/CrashReporter/ (or whatever)
 exists and is writable by the jukebox user.