aboutsummaryrefslogtreecommitdiffstats
path: root/doc/INSTALL.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/INSTALL.md')
-rw-r--r--doc/INSTALL.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index aa9626afe..b805ee0c5 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -308,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
@@ -323,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
@@ -336,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