diff options
author | Louise Crow <louise.crow@gmail.com> | 2014-07-16 16:27:02 +0100 |
---|---|---|
committer | Louise Crow <louise.crow@gmail.com> | 2014-07-16 16:34:59 +0100 |
commit | a860b9fca3f2fd2ba33a3a591824190eb74a3e1a (patch) | |
tree | ffaef68a4463c5cee8e482b2190fa02fd0ab0124 | |
parent | d64abd585d540dd8c36a28c60d0c3e4f522d4c54 (diff) |
Add a 'next steps' page, referenced at the end of install guides.
-rw-r--r-- | _layouts/page.html | 1 | ||||
-rw-r--r-- | docs/installing/ami.md | 3 | ||||
-rw-r--r-- | docs/installing/manual_install.md | 4 | ||||
-rw-r--r-- | docs/installing/next_steps.md | 34 | ||||
-rw-r--r-- | docs/installing/script.md | 20 |
5 files changed, 57 insertions, 5 deletions
diff --git a/_layouts/page.html b/_layouts/page.html index 732532106..d4a8cb4fc 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -51,6 +51,7 @@ layout: default <li><a href="{{ site.baseurl }}docs/installing/manual_install/">Manual Install</a></li> <li><a href="{{ site.baseurl }}docs/installing/deploy/">Deploying</a></li> <li><a href="{{ site.baseurl }}docs/installing/email/">MTA (email)</a></li> + <li><a href="{{ site.baseurl }}docs/installing/next_steps/">Next steps</a></li> </ul> </li> <li><a href="{{ site.baseurl }}docs/customising/">Customising</a> diff --git a/docs/installing/ami.md b/docs/installing/ami.md index e63e70023..e16c712b6 100644 --- a/docs/installing/ami.md +++ b/docs/installing/ami.md @@ -57,3 +57,6 @@ If you have any problems or questions, please ask on the [Alaveteli Google Group](https://groups.google.com/forum/#!forum/alaveteli-dev) or [report an issue](https://github.com/mysociety/alaveteli/issues?state=open). +##What next? + +Check out the [next steps]({{ site.baseurl }}docs/installing/next_steps/). diff --git a/docs/installing/manual_install.md b/docs/installing/manual_install.md index 603db14c0..5ab2103a2 100644 --- a/docs/installing/manual_install.md +++ b/docs/installing/manual_install.md @@ -541,6 +541,10 @@ and so it knows to include that in any absolute urls it serves. We have some [production server best practice notes]({{ site.baseurl}}docs/running/server/). +## What next? + +Check out the [next steps]({{ site.baseurl }}docs/installing/next_steps/). + ## Troubleshooting * **Incoming emails aren't appearing in my Alaveteli install** diff --git a/docs/installing/next_steps.md b/docs/installing/next_steps.md new file mode 100644 index 000000000..98a661416 --- /dev/null +++ b/docs/installing/next_steps.md @@ -0,0 +1,34 @@ +--- +layout: page +title: Next Steps +--- +# Next Steps + +<p class="lead"> + OK, you've installed a copy of Alaveteli, and can see the site in a browser. What next? +</p> + + +### Create a superuser account for yourself + +* Sign up for a new account on the site. You should receive a confirmation email. Click on the link in it to confirm the account. + +* Get access to the [admin interface]({{ site.baseurl}}docs/running/admin_manual/#administrator-privileges). You can find the +`general.yml` file you'll need to get the `ADMIN_USERNAME` and +`ADMIN_PASSWORD` credentials in the `config` subdirectory of the +directory Alaveteli was installed into. + +* In the admin interface, go to the 'Users' section and find the account you just created. Promote the account you just created to superuser status by clicking the 'Edit' button and setting the 'Admin level' value to 'super'. + +### Test out the request process + +* Create a new public authority in the admin interface - give it a name something like 'Test authority'. Set the request email to an address that you will receive. + +* From the main interface of the site, make a request to the new authority. + +* You should receive the request email - try replying to it. Your response email should appear in Alaveteli. Not working? Take a look at our [troubleshooting tips]({{ site.baseurl}}docs/installing/manual_install/#troubleshooting). If that doesn't sort it out, [get in touch]({{ site.baseurl}}community/) on the project mailing list or IRC +for help. + +### Start thinking about customising Alaveteli + +Check out [our guide]({{ site.baseurl}}docs/customising/). diff --git a/docs/installing/script.md b/docs/installing/script.md index 61cb76587..72fbd6438 100644 --- a/docs/installing/script.md +++ b/docs/installing/script.md @@ -16,7 +16,7 @@ Note that there are [other ways to install Alaveteli]({{ site.baseurl }}docs/ins If you have a clean installation of Debian squeeze 64-bit or Ubuntu precise, you can use an install script in our commonlib repository to set up a working instance of Alaveteli. This is not suitable for production (it runs in development mode, -for example) but should set up a functional installation of the site. +for example) but should set up a functional installation of the site, which can send and receive email. **Warning: only use this script on a newly installed server – it will make significant changes to your server’s setup, including modifying your nginx @@ -56,10 +56,20 @@ could download the script, make it executable and then invoke it with: sudo ./install-site.sh --default alaveteli alaveteli +If you have any problems or questions, please ask on the [Alaveteli Google + Group](https://groups.google.com/forum/#!forum/alaveteli-dev) or [report an + issue](https://github.com/mysociety/alaveteli/issues?state=open). + +## What the install script does + When the script has finished, you should have a working copy of the website, -accessible via the hostname you supplied to the script. +accessible via the hostname you supplied to the script. So, for this example, you could access the site in a browser at `http://alaveteli.10.10.10.30.xip.io`. The site runs using the thin application server, and the nginx webserver. By default, Alaveteli will be installed into `/var/www/[HOST]` on the server. + +The server will also be configured to accept replies to information request emails (as long as the MX record for the domain is pointing at the server). Incoming mail handling is set up using Postfix as the MTA. + +##What next? + +Check out the [next steps]({{ site.baseurl }}docs/installing/next_steps/). + -If you have any problems or questions, please ask on the [Alaveteli Google -Group](https://groups.google.com/forum/#!forum/alaveteli-dev) or [report an -issue](https://github.com/mysociety/alaveteli/issues?state=open). |