aboutsummaryrefslogtreecommitdiffstats
path: root/docs/installing/manual_install.md
diff options
context:
space:
mode:
authorGareth Rees <gareth@mysociety.org>2014-06-19 13:07:36 +0100
committerGareth Rees <gareth@mysociety.org>2014-07-03 12:38:19 +0100
commitf425944c05feeba1a5ad471884474e5cce26a515 (patch)
treec71575276ecf4c61931b3a46409100266bce71df /docs/installing/manual_install.md
parentec7ee8389f9e1508635e9910aae51586b5304ec9 (diff)
Add better examples for generating the alert daemon
Diffstat (limited to 'docs/installing/manual_install.md')
-rw-r--r--docs/installing/manual_install.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/installing/manual_install.md b/docs/installing/manual_install.md
index 6002682fe..b9686f7a5 100644
--- a/docs/installing/manual_install.md
+++ b/docs/installing/manual_install.md
@@ -375,7 +375,7 @@ The `ugly` format uses simple variable substitution. A variable looks like
WhatDoTheyKnow. mySociety render the example file to reference absolute paths,
and then drop it in `/etc/cron.d/` on the server.
-The variables are:
+**Template Variables:**
* `vhost_dir`: the full path to the directory where alaveteli is checked out.
e.g. If your checkout is at `/var/www/alaveteli` then set this to `/var/www`
@@ -399,10 +399,22 @@ useful to you. Change the variables to suit your installation.
### Generate alert daemon
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. You can use the rake task `rake
-config_files:convert_init_script` to do this.
+is an init script, which can be generated from the
+`config/alert-tracks-debian.ugly` template.
+
+**Template Variables:**
+
+* `vhost_dir`: the full path to the directory where alaveteli is checked out.
+ e.g. If your checkout is at `/var/www/alaveteli` then set this to `/var/www`
+* `user`: the user that the software runs as
+
+There is a rake task that will help to rewrite this file into one that is
+useful to you. Change the variables to suit your installation.
+
+ bundle exec rake config_files:convert_init_script \
+ DEPLOY_USER=deploy \
+ VHOST_DIR=/var/www \
+ SCRIPT_FILE=config/alert-tracks-debian.ugly > /etc/init.d/foi-alert-tracks
### Generate varnish purge daemon