From 931e54cf6a6289c20ff9fda08fa475b241c8007c Mon Sep 17 00:00:00 2001 From: Dave Whiteland Date: Wed, 7 Jan 2015 15:55:00 +0000 Subject: new entries and small tidies in glossary around admin/superuser --- docs/glossary.md | 67 +++++++++++++++++++++++++++++++++++++-- docs/installing/manual_install.md | 7 +++- docs/installing/next_steps.md | 4 ++- docs/running/admin_manual.md | 41 +++++++++++++++++------- 4 files changed, 103 insertions(+), 16 deletions(-) (limited to 'docs') diff --git a/docs/glossary.md b/docs/glossary.md index b5239a32a..3ae5e6a3c 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -16,6 +16,7 @@ Definitions @@ -78,6 +80,40 @@ Definitions +
+ admin interface (also: admin) +
+
+ The admin interface allows users who have + super + administrator privilege to manage some aspects of how your + Alaveteli site runs. +
+

More information:

+
    +
  • + You can access your installation's admin interface + at /admin. +
    • +
  • + To grant a user admin privilege, log into the admin and change + their Admin level to "super" (or revoke the privilege + by changing it to "none"). +
    • +
  • + On a newly-installed Alaveteli system, you can grant yourself + admin privilege by using the + emergency + user. +
    • +
  • + For lots more about running an Alaveteli site, see the + adminstrator's guide. +
    • +
+
+
+
asker agnostic
@@ -266,7 +302,7 @@ Definitions
- Freedom of Information (also FOI) + Freedom of Information (also: FOI)
Freedom of information laws allow access by the general public @@ -287,7 +323,7 @@ Definitions
- git (also github, git repository, and git repo) + git (also: github, git repository, and git repo)
We use a popular source code control system called git. This @@ -617,7 +653,7 @@ Definitions
- Ruby on Rails (also Rails) + Ruby on Rails (also: Rails)
Alaveteli is written in the Ruby programming language, using @@ -720,6 +756,31 @@ Definitions
+
+ superuser (also: super privilege) +
+
+ A superuser is an Alaveteli user who has been granted + the privilege to use all features of the + admin interface. +
+

More information:

+
    +
  • + To grant a user admin privilege, log into the admin and change + their Admin level to "super" (or revoke the privilege + by changing it to "none"). +
    • +
  • + On a newly-installed Alaveteli system, you can grant yourself + admin privilege by using the + emergency + user. +
    • +
+
+
+
theme
diff --git a/docs/installing/manual_install.md b/docs/installing/manual_install.md index 8c9e2a8d6..9cad6b5b9 100644 --- a/docs/installing/manual_install.md +++ b/docs/installing/manual_install.md @@ -351,7 +351,12 @@ Example `development` section of `config/database.yml`: Make sure that the user specified in `database.yml` exists, and has full permissions on these databases. -As the user needs the ability to turn off constraints whilst running the tests they also need to be a superuser. If you don't want your database user to be a superuser, you can add this line to the `test` section in `database.yml` (as seen in `config/database.yml-example`): +As the user needs the ability to turn off constraints whilst running the tests +they also need to be a superuser (clarification: a Postgres superuser, +not an Alaveteli +superuser). +If you don't want your database user to be a superuser, you can add this line +to the `test` section in `database.yml` (as seen in `config/database.yml-example`): constraint_disabling: false diff --git a/docs/installing/next_steps.md b/docs/installing/next_steps.md index 4199daabf..20c69a504 100644 --- a/docs/installing/next_steps.md +++ b/docs/installing/next_steps.md @@ -14,7 +14,9 @@ Alaveteli ships with an emergency user that has access to the admin. So when you've just created a new site, you should sign up to create your own account, then log into admin as the emergency -user to promote your new account to be an administrator with *super* privileges. +user to promote your new account to be an administrator with +super +privilege. As soon as that's done, disable the emergency user, because you don't need to use it any more: you've superseded it with your new admin account. diff --git a/docs/running/admin_manual.md b/docs/running/admin_manual.md index d166cb859..a846732f3 100644 --- a/docs/running/admin_manual.md +++ b/docs/running/admin_manual.md @@ -7,12 +7,23 @@ title: Administrator's guide

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 Freedom of Information site, whatdotheyknow.com. + href="https://www.whatdotheyknow.com">whatdotheyknow.com, since 2008, + so we've included lots of examples from our own experience. +

+
+

+ Before you start... + This admin guide assumes your Alaveteli site is already up and running. + If it's not, you need to follow the steps for + getting started with Alaveteli. +

+
+ In this guide: