aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/CHANGES.md22
-rw-r--r--doc/INSTALL.md8
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
index 51da903b1..968c34eff 100644
--- a/doc/CHANGES.md
+++ b/doc/CHANGES.md
@@ -3,17 +3,39 @@
## 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.
+
# Version 0.5.1
## Highlighted features
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index 57514332b..4fded2b7f 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -327,6 +327,14 @@ which lives in `config/alert-tracks-debian.ugly`. As with the cron
jobs above, replace the variables (and/or bits near the variables)
with paths to your software.
+One of the cron jobs refers to a script at
+`/etc/init.d/foi-alert-tracks`. This is an init script, a copy of
+which lives in `config/alert-tracks-debian.ugly`. As with the cron
+jobs above, replace the variables (and/or bits near the variables)
+with paths to your software. `config/purge-varnish-debian.ugly` is a
+similar init script, which is optional and not required if you choose
+not to run your site behind Varnish (see below).
+
# Set up production web server
It is not recommended to run the website using the default Rails web