diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES.md | 13 | ||||
| -rw-r--r-- | doc/INSTALL-exim4.md | 11 | ||||
| -rw-r--r-- | doc/INSTALL.md | 20 |
3 files changed, 43 insertions, 1 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md index d4b8ca379..ceb0d791a 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,3 +1,16 @@ +# Version 0.5 + +## Highlighted features +* It should now be possible to develop the software on OSX +* Base design refactored: CSS simplified and reduced, base design colours removed, now provided in example Alaveteli theme override + +## Upgrade notes +* Themes created for 0.4 and below will need to be changed to match the new format. + * You should create a resources folder at `<yourtheme>/public/` and symlink to it from the main rails app. See the `install.rb` in `alaveteli-theme` example theme for details. + * Your styles should be moved from `general/custom_styles.rhtml` to a standalone stylesheet in `<yourtheme>/public/stylesheets/` + * The partial at `general/_before_head_end.rhtml` should be changed in the theme to include this stylesheet + + # Version 0.4 ## Highlighted features diff --git a/doc/INSTALL-exim4.md b/doc/INSTALL-exim4.md index 0f5dda547..69844d2e1 100644 --- a/doc/INSTALL-exim4.md +++ b/doc/INSTALL-exim4.md @@ -5,6 +5,13 @@ 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 + +(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. In `/etc/exim4/conf.d/router/04_alaveteli`: @@ -68,3 +75,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 f6317057e..bb8c7de21 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -237,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 @@ -261,3 +266,16 @@ is supplied in `../conf/varnish-alaveteli.vcl`. Did you remember to remove the file `alaveteli/config/rails_env.rb` as described above? It's created every time you run `script/rails-post-deploy` + +* **Non-ASCII characters are being displayed as asterisks in my incoming messages** + + We rely on `elinks` to convert HTML email to plain text. + Normally, the encoding should just work, but under some + circumstances it appears that `elinks` ignores the parameters + passed to it from Alaveteli. + + To force `elinks` always to treat input as UTF8, add the following + to `/etc/elinks/elinks.conf`: + + set document.codepage.assume = "utf-8" + |