update README.upgrades

[disorder] / README.upgrades

diff --git a/README.upgrades b/README.upgrades
index a042ee578921bc8e204b9f076792fcc26ddb661f..63b7852e09dfb7fbc6bfd3666b6c3cbac3cb1b51 100644 (file)
--- a/README.upgrades
+++ b/README.upgrades
@@ -15,7 +15,24 @@ 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.
+
+* 3.0 -> 3.1
+
+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
 
@@ -34,6 +51,8 @@ after the first run you should remove these directives and (optionally) add a
 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
@@ -42,6 +61,10 @@ 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
@@ -50,6 +73,15 @@ in using their main DisOrder password and the one in the htpassed file is now
 obsolete.  You should revisit the web interface setup instructions in README
 from scratch.
 
+** 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
 
 ** 'transform' and 'namepart' directives