aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/CHANGES.md24
-rw-r--r--doc/INSTALL-exim4.md2
-rw-r--r--doc/INSTALL-postfix.md28
-rw-r--r--doc/INSTALL.md10
4 files changed, 63 insertions, 1 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
index d3faa101d..2fd26fcbe 100644
--- a/doc/CHANGES.md
+++ b/doc/CHANGES.md
@@ -1,3 +1,27 @@
+# Version 0.6.8
+## Highlighted features
+
+* Support for using Postfix as Alaveteli's MTA, instead of Exim (Matthew Landauer)
+* Some preparation for getting Alaveteli working with Ruby 1.9 (James McKinney) - more to come here in future releases!
+* Optional support for using New Relic for performance monitoring (Matthew Landauer)
+* Support for showing all dates and times in the local time zone (Matthew Landauer)
+* Display of authority disclosure logs where the URL is added (Matthew Landauer)
+* Better handling of nil/empty option config parameters (Henare Degan)
+* The option to specify a particular theme branch to use (Matthew Landauer)
+* Some performance improvements, particularly over 0.6.7 (Louise Crow)
+
+* [List of issues on github](https://github.com/mysociety/alaveteli/issues?milestone=24&state=closed)
+
+## Upgrade notes
+* Ensure you have values for new config variables (see `config/general.yml-example`):
+ * TIME_ZONE (if not set, defaults to UTC)
+ * TWITTER_WIDGET_ID (no Twitter widget is displayed if not set)
+ * THEME_BRANCH (defaults to tagged version specific to your version of alaveteli or, failing that, to master)
+ * MTA_LOG_PATH
+ * MTA_LOG_TYPE (defaults to Exim)
+* Copy config/newrelic.yml-example to config/newrelic.yml - by default monitoring is switched off, see https://github.com/newrelic/rpm for instructions on switching on local and remote performance analysis.
+* Check out this version and run `rails-post-deploy` as usual.
+* Note that mailcatcher is now used in development - see http://mailcatcher.me/ for details
# Version 0.6.7
## Highlighted features
* The ability to calculate due dates using calendar, not working days (Matthew Landauer)
diff --git a/doc/INSTALL-exim4.md b/doc/INSTALL-exim4.md
index 91c3506d3..e37da14ff 100644
--- a/doc/INSTALL-exim4.md
+++ b/doc/INSTALL-exim4.md
@@ -11,7 +11,7 @@ In `/etc/exim4/conf.d/main/04_alaveteli_options`:
(The user ALAVETELI_USER should have write permissions on ALAVETELI_HOME).
Note that the name and location of the log files created by Exim must match
-what the `load-exim-logs` script expects, hence the need for the extra
+what the `load-mail-server-logs` script expects, hence the need for the extra
`log_file_path` setting. And the `check-recent-requests-sent` scripts expects
the logs to contain the `from=<...>` envelope information, so we make the
logs more verbose with `log_selector`.
diff --git a/doc/INSTALL-postfix.md b/doc/INSTALL-postfix.md
index 70a2954bd..a73d67ce1 100644
--- a/doc/INSTALL-postfix.md
+++ b/doc/INSTALL-postfix.md
@@ -31,6 +31,34 @@ following to /etc/aliases:
# We use this for envelope from for some messages where we don't care about delivery
do-not-reply-to-this-address: :blackhole:
+# Logging
+
+For the postfix logs to be read by the script 'load-mail-server-logs' succesfully they need to be log rotated with a date in the filename. Since that will create a lot of rotated log files (one for each day), it's good to have them in their own directory. For example (on Ubuntu) /etc/rsyslog.d/50-default.conf
+
+ mail.* -/var/log/mail/mail.log
+
+And also edit /etc/logrotate.d/rsyslog:
+
+ /var/log/mail/mail.log
+ {
+ rotate 30
+ daily
+ dateext
+ missingok
+ notifempty
+ compress
+ delaycompress
+ sharedscripts
+ postrotate
+ reload rsyslog >/dev/null 2>&1 || true
+ endscript
+ }
+
+You'll also need to tell Alaveteli where the log files are stored and that they're in postfix format. Update config/general.yml with:
+
+ MTA_LOG_PATH: '/var/log/mail/mail.log-*'
+ MTA_LOG_TYPE: "postfix"
+
# Troubleshooting
To test mail delivery, run:
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index b805ee0c5..761121139 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -164,6 +164,10 @@ emails. Full configuration for an MTA is beyond the scope of this
document, though we describe an example configuration for Exim in
`INSTALL-exim4.md`.
+Note that in development mode, mail is handled by default by mailcatcher
+so that you can see the mails in a browser - see http://mailcatcher.me/
+for more details.
+
## Minimal
If you just want to get the tests to pass, you will at a minimum need
@@ -222,6 +226,12 @@ Interlock Rails plugin, to cache content using memcached. You
probably don't want this in your development profile; the example
`memcached.yml` file disables this behaviour.
+Finally, copy `config/newrelic.yml-example` to `config/newrelic.yml`.
+This file contains configuration information for the New Relic
+performance management system. By default, monitoring is switched off
+by the `agent_enabled: false` setting. See https://github.com/newrelic/rpm
+for instructions on switching on local and remote performance analysis.
+
# Deployment
In the 'alaveteli' directory, run: