diff options
| -rw-r--r-- | INSTALL.txt | 52 |
1 files changed, 34 insertions, 18 deletions
diff --git a/INSTALL.txt b/INSTALL.txt index 5782b2b6f..304d912b3 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -80,7 +80,26 @@ constraints whilst running the tests they also need to be a superuser. ALTER DATABASE foi_development OWNER TO <username>; ALTER DATABASE foi_test OWNER TO <username>; -3. Deployment + +3. Set up configs +----------------- + +For overall application settings, copy config/general-example to +config/general and edit to your taste. + +Note that the default settings for frontpage examples are designed to +work with the dummy data shipped with Alaveteli; once you have real +data, you should edit these. + +The default theme is the "WhatDoTheyKnow" theme. When you run +rails-post-deploy, that theme gets installed automatically. + +You'll also want to copy config/memcached.yml-example to +config/memcached.yml. The application is configured, via the Interlock +Rails plugin, to cache content using memcached. You probably don't +want this in your development profile. + +4. Deployment ------------- In the 'alaveteli' directory, run: @@ -95,6 +114,12 @@ tests run against our test database, rather than the development one. (Otherwise, any data you create in development will be blown away every time you run the tests.) +If you want some dummy data to play with, you can try loading the +fixtures that the test suite uses into your development database. You +can do this with: + +> rake spec:db:fixtures:load + Next we need to create the index for the search engine (Xapian): > ./script/rebuild-xapian-index @@ -102,7 +127,7 @@ Next we need to create the index for the search engine (Xapian): If this fails, the site should still mostly run, but it's a core component so you should really try to get this working. -4. Run the Tests +5. Run the Tests ---------------- Make sure everything looks OK: @@ -114,7 +139,7 @@ steps. You might be able to move on to the next step, depending on how serious they are, but ideally you should try to find out what's gone wrong. -5. Run the Server +6. Run the Server ----------------- run the following to get the server running (may need to chmod 755 again) @@ -127,13 +152,13 @@ You’ll probably need to install various things to make this work. The server script will tell you about any missing dependencies. -5. Success +7. Success ---------- The server should have told you the URL to access in your browser to see the site in action. -6. Administrator privileges +8. Administrator privileges --------------------------- By default, anyone can access the administrator pages without authentication. @@ -150,24 +175,15 @@ level 'super'). behaviour. And send us the patch! -7. Set up configs ------------------ - -For overall application settings, copy config/general-example to config/general and edit to your taste. - -You'll also want to copy config/memcached.yml-example to -config/memcached.yml. The application is configured, via the Interlock -Rails plugin, to cache content using memcached. You probably don't -want this in your development profile. - -8. Mailer setup +9. Mailer setup --------------- When an authority receives an email, its reply-to address is a magic email which is parsed and consumed by the Rails app. Currently, this is done by calling script/mailin and piping in the raw -email. You will need to configure your MTA to accept emails to magic addresses, and to pipe such emails to this script. +email. You will need to configure your MTA to accept emails to magic +addresses, and to pipe such emails to this script. Magic email addresses are of the form: @@ -193,7 +209,7 @@ case. This setup isn't very scaleable, as it spawns a new Ruby process for each email received; patches welcome! -9. Cron jobs +10. Cron jobs ------------ config/crontab.ugly contains the cronjobs we run on WhatDoTheyKnow. It's |