Clean up online registration confirmation strings. Now they are

[disorder] / README.upgrades

diff --git a/README.upgrades b/README.upgrades
index d9db551e6508ac1ee61652eb6f77ded13ec04972..cbe86373ebff24bb87f2f4a981f5ac10807f9450 100644 (file)
--- a/README.upgrades
+++ b/README.upgrades
@@ -15,7 +15,32 @@ upgrading between particular versions.  Minor versions are not
 explicitly mentioned; a version number like 1.1 implicitly includes
 all 1.1.x versions.
 
-* 2.0 -> 2.1
+If you install from .deb files then much of this work is automated.
+
+* 4.x -> 4.4
+
+The syntax of confirmation strings for online registrations has changed and old
+ones no longer work.  This only affects users who registered before the upgrade
+but have not yet confirmed their login.  You can delete such half-created users
+with 'disorder deluser USERNAME' (as an administrative user, for instance as
+root on the server) and they can start the registration process again.
+
+* 3.0 -> 4.x
+
+If you customized any of the templates, you will pretty much have to start from
+scratch as the web interface has been rewritten.  See disorder.cgi(8) for a
+starting point.
+
+The 'gap' directive will no longer work.  You must delete it from any
+configuration files that contain it.
+
+You may prefer to remove any 'smtp_server' directive you have, as the web
+interface will now use the local sendmail executable if available.
+
+If you want to be able to do use management over non-local connections (thereby
+potentially exposing passwords!) you must set 'remote_userman' to 'yes'.
+
+* 2.0 -> 3.0
 
 ** Authentication
 
@@ -31,14 +56,47 @@ after the first run you should remove these directives and (optionally) add a
 'default_rights' directive.
 
 'allow', 'restrict' and 'trust' will stop working entirely in a future version
-but for now they will generate harmless error messages.
+but for now they will generate harmless error messages.  Remove them and the
+error messages will go away.
+
+See README for new setup instructions for the web interface.
+
+** Other Server Configuration
+
+Sensible defaults for 'stopword', 'player' and 'tracklength' are now built into
+the server.  If you haven't modified the values from the example or Debian
+configuration files then you can remove them.
+
+'gap' now defaults to 0 seconds instead of 2.
+
+The sound output API is now configured with the 'api' command although
+'speaker_backend' still works.  If you use 'api alsa' then you may need to
+change your 'mixer' and 'channel' settings.
 
 ** Web Interface
 
 The web interface no longer uses HTTP basic authentication and the web server
 configuration imposing access control on it should be removed.  Users now log
 in using their main DisOrder password and the one in the htpassed file is now
-obsolete.
+obsolete.  You should revisit the web interface setup instructions in README
+from scratch.
+
+As part of this, the DisOrder URL has changed from (e.g.)
+
+    http://yourserver/cgi-bin/disorder/disorder
+
+to just
+
+    http://yourserver/cgi-bin/disorder
+
+** Checklist
+
+   * delete default 'stopword', 'player' and 'tracklength' directives
+   * set 'gap' if you want a non-0 inter-track gap
+   * set 'api' and maybe 'mixer' and 'channel'
+   * perhaps add 'default_rights' directive
+   * delete 'allow', 'restrict' and 'trust' directives after first run
+   * follow new web interface setup in README
 
 * 1.4/1.5 -> 2.0