aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/CHANGES.md35
-rw-r--r--doc/INSTALL-exim4.md33
-rw-r--r--doc/INSTALL.md18
3 files changed, 83 insertions, 3 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
new file mode 100644
index 000000000..d4b8ca379
--- /dev/null
+++ b/doc/CHANGES.md
@@ -0,0 +1,35 @@
+# Version 0.4
+
+## Highlighted features
+* Complete overhaul of design, including improved search, modern look and feel, more twitter links, etc
+* A banner alerts visitors from other countries to existing sites in their country, or exhorts them to make their own
+* Bounce emails that result from user alerts are automatically processed and hard bouncing accounts do not continue to receive alerts.
+ See the new instructions in INSTALL-exim4.md for details of how to set this up.
+* Logged in users now have the ability to download a zipfile of the entire correspondence for a request
+* Improved UI for responding to requests. The user now has a single option to "reply" at the bottom of a request, and can adjust who they are replying to on the next page
+* [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?sort=created&direction=desc&state=closed&milestone=7)
+
+## Upgrade notes
+* Remember to `rake db:migrate` and `git submodule update`
+* Ensure you have values for new config variables (see `config/general.yml-example`):
+ * FORWARD_NONBOUNCE_RESPONSES_TO
+ * TRACK_SENDER_EMAIL
+ * TRACK_SENDER_NAME
+ * HTML_TO_PDF_COMMAND
+* Execute `script/rebuild-xapian-index` to create new xapian index
+ terms used in latest version of search (can take a long time)
+* Install wkhtmltopdf to enable PDFs in downloadable zipfiles. A
+ static binary is recommended on Linux in order to run the command
+ headless: http://code.google.com/p/wkhtmltopdf/downloads/list
+* Ensure your webserver can serve up generated files by symlinking `cache/zips/download` to `public/download` (this is also done by the `rails-post-deploy` script). If you're using Passenger + Apache, you'll need to add a `PassengerResolveSymlinksInDocumentRoot on` directive to the configuration.
+ * Note that the zipfile download functionality will currently hang if you're running Alaveteli single-threaded, as it creates a new request to the server to get the print stylesheet version!
+* Configure your MTA to handle bounce emails from alerts (see INSTALL-exim4.md)
+
+# Version 0.3
+
+## Highlighted features
+* New search filters / UI on request page, authorities page, and search page. Upgrades require a rebuild of the Xapian index (`./script/xapian-index-rebuild`). Design isn't beautiful; to be fixed in next release.
+* Introduce reCaptcha for people apparently coming from foreign countries (to combat spam) (requires values for new config variables `ISO_COUNTRY_CODE` and `GAZE_URL`, and existing config variables `RECAPTCHA_PUBLIC_KEY` and `RECAPTCHA_PRIVATE_KEY`)
+* Better admin interface for editing multiple translations of a public body at once
+## Other
+* [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?milestone=5&state=closed)
diff --git a/doc/INSTALL-exim4.md b/doc/INSTALL-exim4.md
index 6a0e1247e..d7a0be40f 100644
--- a/doc/INSTALL-exim4.md
+++ b/doc/INSTALL-exim4.md
@@ -5,6 +5,16 @@ In `/etc/exim4/conf.d/main/04_alaveteli_options`:
ALAVETELI_HOME=/path/to/alaveteli/software
ALAVETELI_USER=www-data
+ log_file_path=/var/log/exim4/exim-%slog-%D
+ log_selector=+all -retry_defer
+
+(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
+`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`.
In `/etc/exim4/conf.d/router/04_alaveteli`:
@@ -17,7 +27,7 @@ In `/etc/exim4/conf.d/router/04_alaveteli`:
In `/etc/exim4/conf.d/transport/04_alaveteli`:
alaveteli_mailin_transport:
- driver = pipe
+ driver = pipe
command = $address_pipe ${lc:$local_part}
current_directory = ALAVETELI_HOME
home_directory = ALAVETELI_HOME
@@ -30,6 +40,23 @@ content:
^foi\\+.*: |/path/to/alaveteli/software/script/mailin
+You should also configure exim to discard any messages sent to the `BLACKHOLE_PREFIX`
+address, whose default value is 'do-not-reply-to-this-address'. For example, add the
+following to config/aliases:
+
+ # We use this for envelope from for some messages where we don't care about delivery
+ do-not-reply-to-this-address: :blackhole:
+
+If you want to make use of the automatic bounce-message handling, then set the `TRACK_SENDER_EMAIL`
+address to be filtered through `script/handle-mail-replies`. Messages that are not bounces or
+out-of-office autoreplies will be forwarded to `FORWARD_NONBOUNCE_RESPONSES_TO`. For example,
+in WhatDoTheyKnow the configuration looks like this:
+
+ raw_team: [a list of people on the team]
+ team: |/path/to/alaveteli/software/script/handle-mail-replies
+
+with `FORWARD_NONBOUNCE_RESPONSES_TO: 'raw_team@whatdotheyknow.com'`
+
Finally, make sure you have `dc_use_split_config='true'` in
`/etc/exim4/update-exim4.conf.conf`, and execute the command
`update-exim4.conf`
@@ -51,3 +78,7 @@ see something like:
R: alaveteli pipe for snafflerequest-234@localhost
snafflerequest-234@localhost -> |/home/alaveteli/alaveteli/script/mailin
transport = alaveteli_mailin_transport
+
+There is a great
+[Exim Cheatsheet](http://bradthemad.org/tech/notes/exim_cheatsheet.php)
+online that you may find useful.
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index eb0a77dd9..656b96467 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -36,7 +36,16 @@ code. Run:
git submodule update --init
-to fetch the contents of the submodules.
+to fetch the contents of the submodules.
+
+Optionally, you may want to install
+[wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/downloads/list).
+We recommend downloading the latest, statically compiled version from
+the project website, as this allows running headless (i.e. without a
+graphical interface running) on Linux. If you do install
+`wkhtmltopdf`, you need to edit a setting in the config file to point
+to it (see below).
+
# Configure Database
@@ -228,7 +237,12 @@ It is not recommended to run the website using the default Rails web
server. There are various recommendations here:
http://rubyonrails.org/deploy
-We usually use Passenger / mod_rails.
+We usually use Passenger / mod_rails. The file at `conf/httpd.conf`
+contains the WhatDoTheyKnow settings. At a minimum, you should
+include the following in an Apache configuration file:
+
+ PassengerResolveSymlinksInDocumentRoot on
+ PassengerMaxPoolSize 6 # Recommend setting this to 3 or less on servers with 512MB RAM
Under all but light loads, it is strongly recommended to run the
server behind an http accelerator like Varnish. A sample varnish VCL