diff options
Diffstat (limited to 'docs/running')
| -rw-r--r-- | docs/running/admin_manual.md | 4 | ||||
| -rw-r--r-- | docs/running/index.md | 6 | ||||
| -rw-r--r-- | docs/running/server.md | 11 | ||||
| -rw-r--r-- | docs/running/states.md | 6 | ||||
| -rw-r--r-- | docs/running/states_informatazyrtare.md | 4 |
5 files changed, 15 insertions, 16 deletions
diff --git a/docs/running/admin_manual.md b/docs/running/admin_manual.md index a5f7e174e..77bacdf1b 100644 --- a/docs/running/admin_manual.md +++ b/docs/running/admin_manual.md @@ -6,14 +6,14 @@ title: Administrator's guide # Alaveteli administrator's guide <p class="lead"> - What is it like running an Alaveteli site? This guide explains what you can expect, and the types of problem that you might encounter. It includes examples of how mySociety manages their own <a href="/docs/glossary/#foi" class="glossary">Freedom of Information</a> site, <a href="http://www.whatdotheyknow.com">whatdotheyknow.com</a>. + What is it like running an Alaveteli site? This guide explains what you can expect, and the types of problem that you might encounter. It includes examples of how mySociety manages their own <a href="/docs/glossary/#foi" class="glossary">Freedom of Information</a> site, <a href="https://www.whatdotheyknow.com">whatdotheyknow.com</a>. </p> ## What's involved? The overhead in managing a successful FOI website is quite high. Richard, a volunteer, wrote a [blog -post](http://www.mysociety.org/2009/10/13/behind-whatdotheyknow/) about some of +post](https://www.mysociety.org/2009/10/13/behind-whatdotheyknow/) about some of this in 2009. WhatDoTheyKnow usually has about 3 active volunteers at any one time managing diff --git a/docs/running/index.md b/docs/running/index.md index 3db94f713..90461fb3e 100644 --- a/docs/running/index.md +++ b/docs/running/index.md @@ -16,13 +16,13 @@ site, you need to make sure day-to-day tasks get done too. Most Alaveteli sites are run by a team who allocate some time every day to user support and generally keeping the project up to date. -* the [administrator's guide]({{ site.baseurl }}docs/running/admin_manual) describes +* the [administrator's guide]({{ site.baseurl }}docs/running/admin_manual/) describes what you need to do and know to run your site * we've prepared a checklist of - [things to consider]({{ site.baseurl }}docs/running/server) + [things to consider]({{ site.baseurl }}docs/running/server/) when setting up your production server -* see the [different states a request can be in]({{ site.baseurl }}docs/running/states) +* see the [different states a request can be in]({{ site.baseurl }}docs/running/states/) diff --git a/docs/running/server.md b/docs/running/server.md index 63ec1800f..c10d4b4b4 100644 --- a/docs/running/server.md +++ b/docs/running/server.md @@ -25,7 +25,7 @@ ask us about hosting. ## Cron jobs Don't forget to set up the cron jobs as outlined in the -[installation instructions]({{ site.baseurl }}docs/installing/manual_install). +[installation instructions]({{ site.baseurl }}docs/installing/manual_install/). As of October 2011, they rely on a small program created by mySociety called `run-with-lockfile`. A discussion of where the source for this can be found, and possible alternatives, lives in @@ -36,7 +36,7 @@ and possible alternatives, lives in We recommend running your site behind [Apache](https://httpd.apache.org) + [Passenger](https://www.phusionpassenger.com). Refer to the -[installation instructions]({{ site.baseurl }}docs/installing/manual_install) +[installation instructions]({{ site.baseurl }}docs/installing/manual_install/) regarding `PassengerMaxPoolSize`, which you should experiment with to match your available RAM. It is very unlikely that you'll ever need a pool larger than [Passenger's @@ -49,7 +49,7 @@ Alaveteli ships with a ## Security -You _must_ change all key-related [config settings]({{ site.baseurl }}docs/customising/config) +You _must_ change all key-related [config settings]({{ site.baseurl }}docs/customising/config/) in `general.yml` from their default values. This includes (but may not be limited to!) these settings: @@ -76,11 +76,10 @@ deliverability of your email: * Set up [SPF records](http://www.openspf.org/) for your domain * Set up <a - href="http://en.wikipedia.org/wiki/Feedback_loop_(email)#Feedback_loop_links_f - or_some_email_providers">feedback loops</a> with the main email providers + href="http://wiki.asrg.sp.am/wiki/Feedback_loop_links_for_some_email_providers">feedback loops</a> with the main email providers (Hotmail and Yahoo! are recommended) * Especially if deploying from Amazon EC2, use an external SMTP relay for - sending outgoing mail. See [Alaveteli EC2 AMI]( {{ site.baseurl }}docs/installing/ami) + sending outgoing mail. See [Alaveteli EC2 AMI]( {{ site.baseurl }}docs/installing/ami/) for more suggestions. ## Backup diff --git a/docs/running/states.md b/docs/running/states.md index 73e49eba7..1c3fb217e 100644 --- a/docs/running/states.md +++ b/docs/running/states.md @@ -15,16 +15,16 @@ The request states are defined in the Alaveteli code, and we recommend you use them (provided they match the <a href="{{ site.baseurl }}docs/glossary/#foi" class="glossary">FOI law</a> in your own jurisdiction). But if you do need to customise them, you can — see -<a href="{{ site.baseurl }}docs/customising/themes">Customising the request states</a> for details. +<a href="{{ site.baseurl }}docs/customising/themes/">Customising the request states</a> for details. ## WhatDoTheyKnow example -Requests made on the UK's Alaveteli instance, [WhatDoTheyKnow](http://www.whatdotheyknow.com), +Requests made on the UK's Alaveteli instance, [WhatDoTheyKnow](https://www.whatdotheyknow.com), may be in any of the states described below. Note that your site doesn't need to use the same states as WhatDoTheyKnow does. For example, Kosovo's instance uses slightly different states: see -[this comparison of their differences]({{ site.baseurl }}docs/running/states_informatazyrtare). +[this comparison of their differences]({{ site.baseurl }}docs/running/states_informatazyrtare/). ### States diff --git a/docs/running/states_informatazyrtare.md b/docs/running/states_informatazyrtare.md index 8097244c5..bd5ff1a1c 100644 --- a/docs/running/states_informatazyrtare.md +++ b/docs/running/states_informatazyrtare.md @@ -29,7 +29,7 @@ facilitates this by allowing you to customise the states that are used. This example is to show clearly that you can use different states depending on your local requirements, and how that might look. See [Customising the request -states]({{ site.baseurl }}docs/customising/themes) for details on how to do this. +states]({{ site.baseurl }}docs/customising/themes/) for details on how to do this. ### States used by InformataZyrtare but not WDTK @@ -45,7 +45,7 @@ states]({{ site.baseurl }}docs/customising/themes) for details on how to do this * <a href="{{ site.baseurl }}docs/running/states/#user_withdrawn">user_withdrawn</a> * <a href="{{ site.baseurl }}docs/running/states/#waiting_response_very_overdue">waiting_response_very_overdue</a> -For more details, see all the [states used by WhatDoTheyKnow]({{site.baseurl}}docs/running/states)) for details. +For more details, see all the [states used by WhatDoTheyKnow]({{site.baseurl}}docs/running/states/)) for details. --- |