diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES.md | 17 | ||||
| -rw-r--r-- | doc/DEPLOY.md | 3 | ||||
| -rw-r--r-- | doc/INSTALL.md | 29 | ||||
| -rw-r--r-- | doc/THEMES.md | 2 |
4 files changed, 44 insertions, 7 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md index 15df1dce5..d3faa101d 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,3 +1,20 @@ +# Version 0.6.7 +## Highlighted features +* The ability to calculate due dates using calendar, not working days (Matthew Landauer) +* A refactor and standardization of the configuation variables and defaults using a central module (Matthew Landauer) +* The use of full URLs in admin attention emails, and associated modification of the admin_url helper to always return full urls (Henare Degan) +* The ability to disable comments on a request (Robin Houston) +* Some previously missed strings for translation, courtesy of the Czech translation team + +* [List of issues on github](https://github.com/mysociety/alaveteli/issues?milestone=23&state=closed) + + +## Upgrade notes + +* Themes created for 0.6.6 and below should be updated to use the new Configuration module wherever they used Config.get directly previously. +* Check out this version and run `rails-post-deploy` as usual. + + # Version 0.6.6 ## Highlighted features * Adds deployment via Capistrano - see DEPLOY.md for details diff --git a/doc/DEPLOY.md b/doc/DEPLOY.md index adeb0e113..767f720fd 100644 --- a/doc/DEPLOY.md +++ b/doc/DEPLOY.md @@ -19,7 +19,8 @@ These are the general steps required to get your staging server up and running: * Run `cap deploy:update_code` so that we've got a copy of the example config on the server. This process will take a long time installing gems, etc. it will also fail on `rake:themes:install` but that's OK * SSH to the server, change to the `deploy_to` directory * `cp releases/[SOME_DATE]/config/general.yml-example shared/general.yml` -* `cp releases/[SOME_DATE]/config/general.yml-example shared/general.yml` +* `cp releases/[SOME_DATE]/config/database.yml-example shared/database.yml` +* `cp releases/[SOME_DATE]/config/memcached.yml-example shared/memcached.yml` * Edit those files to match your required settings * Back on your machine run `cap deploy` and it should successfully deploy * Run the DB migrations `cap deploy:migrate` diff --git a/doc/INSTALL.md b/doc/INSTALL.md index da72987af..b805ee0c5 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -25,6 +25,18 @@ master branch (which always contains the latest stable release): git checkout master +# Package pinning + +You need to configure [apt-pinning](http://wiki.debian.org/AptPreferences#Pinning-1) preferences in order to prevent packages being pulled from the debian testing distribution in preference to the stable distribution once you have added the testing repository as described below. + +In order to configure apt-pinning and to keep most packages coming from the Debian stable repository while installing the ones required from testing and the mySociety repository you need to run the following commands: + + echo "Package: *" >> /tmp/preferences + echo "Pin: release a=testing">> /tmp/preferences + echo "Pin-Priority: 50" >> /tmp/preferences + sudo cp /tmp/preferences /etc/apt/ + rm /tmp/preferences + # Install system dependencies These are packages that the software depends on: third-party software @@ -296,7 +308,7 @@ in the front end. It is possible completely to override the administrator authentication by setting `SKIP_ADMIN_AUTH` to `true` in `general.yml`. -# Cron jobs +# Cron jobs and init scripts `config/crontab.ugly` contains the cronjobs run on WhatDoTheyKnow. It's in a strange templating format they use in mySociety. mySociety @@ -311,6 +323,10 @@ like `!!(*= $this *)!!`. The variables are: `/data/vhost/!!(*= $vhost *)!!` -- you should replace that whole port with a path to the directory where your Alaveteli software installation lives, e.g. `/var/www/` +* `vhost_dir`: the entire path to the directory where the software is + served from. -- you should replace this with a path to the + directory where your Alaveteli software installation lives, + e.g. `/var/www/` * `vcspath`: the name of the alaveteli checkout, e.g. `alaveteli`. Thus, `/data/vhost/!!(*= $vhost *)!!/!!(*= $vcspath *)!!` might be replaced with `/var/www/alaveteli` in your cron tab @@ -324,11 +340,14 @@ One of the cron jobs refers to a script at `/etc/init.d/foi-alert-tracks`. This is an init script, a copy of which lives in `config/alert-tracks-debian.ugly`. As with the cron jobs above, replace the variables (and/or bits near the variables) -with paths to your software. `config/purge-varnish-debian.ugly` is a +with paths to your software. You can use the rake task `rake +config_files:convert_init_script` to do this. +`config/purge-varnish-debian.ugly` is a similar init script, which is optional and not required if you choose -not to run your site behind Varnish (see below). Either tweak the file permissions to make the script executable by your deploy user, or add the following line to your -sudoers file to allow these to be run by your deploy user (named `deploy` in -this case): +not to run your site behind Varnish (see below). Either tweak the file +permissions to make the scripts executable by your deploy user, or add the +following line to your sudoers file to allow these to be run by your deploy +user (named `deploy` in this case): deploy ALL = NOPASSWD: /etc/init.d/foi-alert-tracks, /etc/init.d/foi-purge-varnish diff --git a/doc/THEMES.md b/doc/THEMES.md index 6c22764fc..c5e4a3eee 100644 --- a/doc/THEMES.md +++ b/doc/THEMES.md @@ -123,7 +123,7 @@ do this in the `alavetelitheme`. To do add states, create two modules in your theme, `InfoRequestCustomStates` and `RequestControllerCustomStates`. The -former must have these two methods: +former must have these methods: * `theme_calculate_status`: return a tag to identify the current state of the request * `theme_extra_states`: return a list of tags which identify the extra states you'd like to support |