aboutsummaryrefslogtreecommitdiffstats
path: root/doc/CHANGES.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/CHANGES.md')
-rw-r--r--doc/CHANGES.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
index 025d72c8d..4796b726f 100644
--- a/doc/CHANGES.md
+++ b/doc/CHANGES.md
@@ -1,3 +1,47 @@
+# Next version
+
+## Highlighted features
+
+* Ruby dependencies are now handled by Bundler
+* Support for invalidating accelerator cache -- this makes it much
+ less likely, when using Varnish, that users will be presented with
+ stale content. Fixes
+ [issue #436](https://github.com/sebbacon/alaveteli/issues/436)
+## Upgrade notes
+
+* Existing installations will need to install the Bundler gem. See
+ `INSTALL.md` for details.
+
+* As a result of using bundler, the list of software packages that
+ should be installed has changed. On Debian, you can run:
+
+ sudo apt-get install `cut -d " " -f 1 config/packages | grep -v "^#"`
+
+ [This gist](https://gist.github.com/2584766) shows the changes to
+ `config/packages` since the previous release.
+
+* Because dependencies are now handled by Bundler, when you next run
+ the `rails-post-deploy` script, it will download, compile and
+ install various things. Part of this is compiling xapian, which may
+ take a *long* time (subsequent deployments should be much faster)
+
+* To support invalidating the Varnish cache, ensure that there's a
+ value for `VARNISH_HOST` in `general.yml` (normally this would be
+ `localhost`). You will also need to update your Varnish server to
+ support PURGE requests. The example configuration provided at
+ `config/varnish-alaveteli.vcl` will work for Varnish 3 and above. If
+ you leave `VARNISH_HOST` blank, it will have no effect. Finally,
+ you should install the `purge-varnish` init script that's provided
+ in `ugly` format at `config/purge-varnish-debian.ugly` to ensure the
+ purge queue is emptied regularly.
+
+* Administrators are now assumed to log in using standard user accounts
+ with superuser privileges (see 'Administrator Privileges' in
+ `INSTALL.md`). The old-style admin account (using credentials from
+ `general.yml`) is now known as the "emergency user". Deployments
+ that previously bypassed admin authentication should set the new
+ `SKIP_ADMIN_AUTH` config variable to `true`.
+
# Version 0.5.1
## Highlighted features