diff options
Diffstat (limited to 'notes')
| -rw-r--r-- | notes/cobranding.txt | 3 | ||||
| -rw-r--r-- | notes/states.txt | 2 | ||||
| -rw-r--r-- | notes/trouble_shooting.md | 42 | ||||
| -rw-r--r-- | notes/vagrant.md | 66 |
4 files changed, 110 insertions, 3 deletions
diff --git a/notes/cobranding.txt b/notes/cobranding.txt index db71c87ce..3e902abc8 100644 --- a/notes/cobranding.txt +++ b/notes/cobranding.txt @@ -13,9 +13,8 @@ NB: this is moderately specific to producing cobrands for UK councils site_restriction problems_clause enter_postcode_text - council_check + area_check base_url - all_councils_report should return 0 disambiguate_location - see below for details on this 2: create a web/cobrands/examplecom folder and put custom css/images/js in here diff --git a/notes/states.txt b/notes/states.txt index 70515c41b..32f9beb1a 100644 --- a/notes/states.txt +++ b/notes/states.txt @@ -22,7 +22,7 @@ the problem has been reported to: Open ( a synonym for confirmed ) Investigating Planned - In Progress + In progress Fixed Closed diff --git a/notes/trouble_shooting.md b/notes/trouble_shooting.md new file mode 100644 index 000000000..7a982ff4b --- /dev/null +++ b/notes/trouble_shooting.md @@ -0,0 +1,42 @@ +# Trouble shooting + +## Empty datetime object + + Couldn't render template "index.html: undef error - Can't call method "strftime" without a package or object reference at /var/www/fixmystreet.127.0.0.1.xip.io/fixmystreet/perllib/Utils.pm line 232 + +- You might have a problem with a datefield that has been left empty by one cobrand that another expects to have a value. Inspert the problem table in the database. +- You may have problems being returned by memcached that your database does not have. Restart memcached to rule this out. + +## Wrong cobrand is displaying + +- Make sure that your hostname does not contain anything that another cobrand is matching on. For example if your config is + +``` yaml +ALLOWED_COBRANDS: + - fixmystreet + - zurich +```` + +Then a domain like `zurich.fixmystreet.com` will match `fixmystreet` first and that is the cobrand that will be served. + +## Account creation emails not arriving + +Your receiving email servers may be rejecting them because: + +* your VM IP address has been blacklisted +* your ISP blocks outgoing connections to port 25 (mobile broadband providers often do this) +* sender verification has failed (applies to `@mysociety.org` servers) - check that your `DO_NOT_REPLY_EMAIL` conf setting passes sender verification (using your own email address works well). + +Perhaps check the entries in `/var/log/mail.log` to check that the message has been sent by the app, and if it has been possible to send them on. + +## Translations not being used + +The locale needs to be installed too or the translations will not be used. Use +`locale -a` to list them all and ensure the one your translation uses is in the +list. + + +## Database connection errors trying to run update-schema + +Make sure that you specify a database host and password in `general.yml`. You +may need to explicitly give your user a password. diff --git a/notes/vagrant.md b/notes/vagrant.md new file mode 100644 index 000000000..0ef9202f7 --- /dev/null +++ b/notes/vagrant.md @@ -0,0 +1,66 @@ +# Using Vagrant + +Vagrant provides an easy method to setup virtual development environments, for +further information see [their website](http://www.vagrantup.com). + +The included steps will use vagrant to create a dev environment where you can +run the test suite, the development server and of course make changes to the +codebase. + +The basic process is to create a "base" vm, and then "provision" it with the +software packages and setup needed. There are several ways to do this, including +Chef, Puppet, or the existing FixMyStreet install script which we will use. The +supplied scripts will create you a Vagrant VM based on the server edition of +Ubuntu 12.04 LTS that contains everything you need to work on FixMyStreet. + +## Pre-requisites + +1. Install [VirtualBox](http://www.virtualbox.org/wiki/Downloads) +2. Install [Vagrant](http://downloads.vagrantup.com/) + +## Get the FixMyStreet code + +Create a folder somewhere that you'll be doing your work from and clone the repo +into it. + +``` bash +mkdir FMS-vagrant +cd FMS-vagrant +git clone --recursive https://github.com/mysociety/fixmystreet.git +``` + +## Set up the Vagrant box + +The vagrant configuration needs to be placed in the correct place. + +``` bash +# NOTE - you need to be in the 'FMS-vagrant' dir + +cp fixmystreet/conf/Vagrantfile.example Vagrantfile + +# start the vagrant box. This will provision the system and can take a long time. +vagrant up --no-color +``` + +## Working with the vagrant box + +You should now have a local FixMyStreet development server to work with. You +can edit the files locally and the changes will be reflected on the virtual +machine. + +To start the dev server: + +``` bash +vagrant ssh + +# You are now in a terminal on the virtual machine +cd /vagrant/fixmystreet + +# run the dev server +bin/cron-wrapper script/fixmystreet_app_server.pl -d -r --fork +``` + +The server should now be running and you can visit it at the address +http://127.0.0.1.xip.io:3000/ + +Enjoy! |