default_rights directive

[disorder] / README.upgrades

diff --git a/README.upgrades b/README.upgrades
index 6e279e76485bf3138c0ec449b24c2b6945fb7781..b47022e5510c040d2f0797e4215a0d61b2d4450d 100644 (file)
--- a/README.upgrades
+++ b/README.upgrades
@@ -2,8 +2,8 @@
 
 The general procedure is:
 
- * stop the old daemon, e.g. with
-     /etc/init.d/disorder stop
+ * stop the old daemon:  /etc/init.d/disorder stop
+ * back up your database directory (example below)
  * build and install the new version as described in the README
  * update the configuration files (see below)
  * start the new daemon, e.g. with
@@ -14,7 +14,25 @@ upgrading between particular versions.  Minor versions are not
 explicitly mentioned; a version number like 1.1 implicitly includes
 all 1.1.x versions.
 
-* 1.5 -> 1.6
+* 2.0 -> 2.1
+
+** Authentication
+
+Users are now stored in the database rather than in 'allow' directives in a
+private configuration file.  'allow' is still understood in this version, but
+is only used to populate the database on startup.  After the first (successful)
+run of the server the remaining 'allow' directives should be deleted.
+
+'restrict' and 'trust' are replaced by a system of per-user rights.  The
+default user rights are based on the 'restrict' setting, and the rights of
+users created frow 'allow' directives preserve the meaning of 'trust', but
+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.
+
+* 1.4/1.5 -> 2.0
 
 ** 'transform' and 'namepart' directives
 
@@ -26,10 +44,33 @@ More importantly however both 'transform' and 'namepart' are now optional, with
 sensible defaults being built in.  So if you were already using the default
 values you can just delete all instances of both.
 
-** enabled' and 'random_enabled' directives
+See disorder_config(5) for the default values.  Hopefuly they will be suitable
+for many configurations.  Please do send feedback.
+
+** 'enabled' and 'random_enabled' directives
 
 These have been removed.  Instead the state persists from one run of the server
-to the next.
+to the next.  If they appear in your configuration file they must be removed;
+the server will not start if they are present.
+
+** Database upgrade
+
+It is strongly recommended that you back up your database before performing the
+upgrade.  For example, as root, with the server STOPPED:
+  cd /var/disorder
+  mkdir BACKUP
+  cp -p * BACKUP
+
+To restore, again as root:
+  cd /var/disorder
+  rm *
+  cp -p BACKUP/* .
+
+The first thing the server does when upgrading from 1.5 is run the
+disorder-dbupgrade program.  This is necessary to modify any non-ASCII track
+names to meet the latest version's stricter normalization practices.  The
+upgrade should succeed automatically; if not it should leave an error message
+in syslog.
 
 * 1.3 -> 1.4
 
@@ -108,5 +149,3 @@ Local Variables:
 mode:outline
 fill-column:79
 End:
-
-# arch-tag:j+OBlcYYyUdGBVbVXVgXew