1.1 --- a/README.txt Tue Feb 05 23:30:41 2013 +0100
1.2 +++ b/README.txt Tue Sep 03 00:33:30 2013 +0200
1.3 @@ -2,11 +2,14 @@
1.4 ------------
1.5
1.6 The ApproveChanges action for MoinMoin, along with the queue_for_review event
1.7 -handler and supporting library, provides a way for contributions to a Wiki
1.8 +handler and supporting library, provides a way for contributions to a wiki
1.9 made by anonymous or untrusted users to be queued for review and approval by
1.10 trusted reviewers.
1.11
1.12 -After installation, some Wiki configuration is required to make sure that the
1.13 +Before installation, a special user has to be added to the wiki for the
1.14 +software to function. See the "Pre-Installation Tasks" for details.
1.15 +
1.16 +After installation, some wiki configuration is required to make sure that the
1.17 queuing and approval mechanisms function correctly. See the "Configuration"
1.18 section below for more information.
1.19
1.20 @@ -56,26 +59,26 @@
1.21
1.22 The pages directory contains a selection of useful pages using a syntax
1.23 appropriate for use with MoinMoin 1.6 or later. These pages can be created
1.24 -through the Wiki and their contents copied in from each of the files. An
1.25 +through the wiki and their contents copied in from each of the files. An
1.26 easier installation method is to issue the following commands:
1.27
1.28 python moinsetup.py -f moinsetup.cfg -m make_page_package $ACDIR/pages pages.zip
1.29 python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
1.30
1.31 You may need to switch user in order to have sufficient privileges to copy the
1.32 -page package into the Wiki. For example:
1.33 +page package into the wiki. For example:
1.34
1.35 sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package pages.zip
1.36
1.37 Resource Pages
1.38 --------------
1.39
1.40 -In order to assign Wiki users to particular roles, some resource pages must be
1.41 -set up in a Wiki. For this purpose, the resource_pages directory contains
1.42 +In order to assign wiki users to particular roles, some resource pages must be
1.43 +set up in a wiki. For this purpose, the resource_pages directory contains
1.44 example pages defining the membership of two groups:
1.45
1.46 ApprovedGroup: the approved users group; users whose changes do not
1.47 - need to approved and who can edit the Wiki normally
1.48 + need to approved and who can edit the wiki normally
1.49
1.50 PageReviewersGroup the reviews group; users who can review the changes
1.51 made by untrusted users
1.52 @@ -95,7 +98,7 @@
1.53 python moinsetup.py -f moinsetup.cfg -m install_page_package resource_pages.zip
1.54
1.55 You may need to switch user in order to have sufficient privileges to copy the
1.56 -page package into the Wiki. For example:
1.57 +page package into the wiki. For example:
1.58
1.59 sudo -u www-data python moinsetup.py -f moinsetup.cfg -m install_page_package resource_pages.zip
1.60
1.61 @@ -104,22 +107,34 @@
1.62
1.63 Once the event handler has been installed, all page saving operations will be
1.64 affected by its operation. With no further configuration, it is most likely
1.65 -that only superusers will be able to save changes to Wiki pages, and even the
1.66 +that only superusers will be able to save changes to wiki pages, and even the
1.67 queuing of changes will not function properly.
1.68
1.69 -Thus, it becomes necessary to change the Wiki configuration to enable the
1.70 +Thus, it becomes necessary to change the wiki configuration to enable the
1.71 successful queuing of changes by changing the acl_rights_before configuration
1.72 setting, adding the following rule:
1.73
1.74 ApprovalQueueUser:write,admin
1.75
1.76 -This will let the special internal Wiki user responsible for queuing changes
1.77 +This will let the special internal wiki user responsible for queuing changes
1.78 (see "Pre-Installation Tasks") save and define an ACL on a page saved by an
1.79 untrusted user. See the following page for more information on access control
1.80 lists (ACLs):
1.81
1.82 http://moinmo.in/HelpOnAccessControlLists
1.83
1.84 +Troubleshooting
1.85 +---------------
1.86 +
1.87 +When a user tries to save a page, they get the following error (or
1.88 +equivalent):
1.89 +
1.90 + You can't change ACLs on this page since you have no admin rights on it!
1.91 +
1.92 +This is possibly caused by the absence of the ApprovalQueueUser (see
1.93 +"Pre-Installation Tasks" above) and/or the acl_rights_before rule for that
1.94 +user (see "Configuration" above).
1.95 +
1.96 Recommended Software
1.97 --------------------
1.98