aboutsummaryrefslogtreecommitdiffstats
path: root/doc/INSTALL.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/INSTALL.md')
-rw-r--r--doc/INSTALL.md42
1 files changed, 38 insertions, 4 deletions
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index bb8c7de21..a666ac2f0 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -1,8 +1,13 @@
-These instructions are based on getting the FOI site up and running on
-Ubuntu and/or Debian.
+These instructions assume Debian Squeeze or Ubuntu 11.04, or later
+(probably, though we won't necessarily have tested in later versions
+yet!)
+[Install instructions for OS X](https://github.com/sebbacon/alaveteli/wiki/OS-X-Quickstart)
+are under development.
-It was last run using the Lucid Lynx version of Ubuntu and on the
-Parallels debian instance (2.6.18-4-686).
+It is possible to install on Ubuntus as old as 10.04, but you must use
+[Xapian backports](https://launchpad.net/~xapian-backports/+archive/xapian-1.2)
+(see [issue #158](https://github.com/sebbacon/alaveteli/issues/159)
+for discussion).
Commands are intended to be run via the terminal or over ssh.
@@ -82,6 +87,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 +295,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`.
+