aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/CHANGES.md3
-rw-r--r--doc/INSTALL-exim4.md7
-rw-r--r--doc/INSTALL.md29
3 files changed, 37 insertions, 2 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
index ceb0d791a..61890275a 100644
--- a/doc/CHANGES.md
+++ b/doc/CHANGES.md
@@ -29,6 +29,9 @@
* TRACK_SENDER_EMAIL
* TRACK_SENDER_NAME
* HTML_TO_PDF_COMMAND
+ * NEW_RESPONSE_REMINDER_AFTER_DAYS
+ * FORCE_REGISTRATION_ON_NEW_REQUEST
+* The config variable `FRONTPAGE_SEARCH_EXAMPLES` is no longer used, so you should remove it to avoid confusion.
* 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
diff --git a/doc/INSTALL-exim4.md b/doc/INSTALL-exim4.md
index 69844d2e1..d7a0be40f 100644
--- a/doc/INSTALL-exim4.md
+++ b/doc/INSTALL-exim4.md
@@ -6,12 +6,15 @@ 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 script `load-exim-logs` expects, hence the need for the extra
-`log_file_path` setting.
+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`:
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index bb8c7de21..a891339e6 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -82,6 +82,18 @@ The following command will set up a user 'foi' with password 'foi':
ALTER DATABASE foi_development OWNER TO foi;
ALTER DATABASE foi_test OWNER TO foi;" | psql
+# Configure email
+
+You will need to set up an email server (MTA) to send and receive
+emails. Full configuration for an MTA is beyond the scope of this
+document. However, just to get the tests to pass, you will at a
+minimum need to allow sending emails via a `sendmail` command (a
+requirement met, for example, with `sudo apt-get install exim4`).
+
+To receive email in a production setup, you will also need to
+configure your MTA to forward incoming emails to Alaveteli. An
+example configuration is described in `INSTALL-exim4.md`.
+
# Set up configs
For overall application settings, copy `config/general.yml-example` to
@@ -278,4 +290,21 @@ is supplied in `../conf/varnish-alaveteli.vcl`.
to `/etc/elinks/elinks.conf`:
set document.codepage.assume = "utf-8"
+
+ You should also check that your locale is set up wrongly. See
+ [https://github.com/sebbacon/alaveteli/issues/128#issuecomment-1814845](this issue followup)
+ for further discussion.
+* **I'm getting lots of `SourceIndex.new(hash) is deprecated` errors when running the tests**
+
+ The latest versions of rubygems contain a large number of noisy
+ deprecation warnings that you can't turn off individually. Rails
+ 2.x isn't under active development so isn't going to get fixed (in
+ the sense of using a non-deprecated API). So the only vaguely
+ sensible way to avoid this noisy output is to downgrade rubygems.
+
+ For example, you might do this by uninstalling your
+ system-packaged rubygems, and then installing the latest rubygems
+ from source, and finally executing `sudo gem update --system
+ 1.6.2`.
+