Changes between Version 30 and Version 31 of PrivateWikiPlugin


Ignore:
Timestamp:
Nov 6, 2015, 3:18:46 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • PrivateWikiPlugin

    v30 v31  
    55== Description
    66
    7 Allows you to protect wiki pages against access.
     7This plugin allows you to protect wiki pages against access.
    88
    99== Bugs/Feature Requests
    1010
    1111Existing bugs and feature requests for PrivateWikiPlugin are
    12 [query:?status=new&status=assigned&status=reopened&group=&component=PrivateWikiPlugin&order=priority here].
     12[report:9?COMPONENT=PrivateWikiPlugin here].
    1313
    1414If you have any issues, create a
    15 [/newticket?component=PrivateWikiPlugin&owner=natewlew new ticket].
     15[/newticket?component=PrivateWikiPlugin new ticket].
    1616
    1717[[TicketQuery(component=PrivateWikiPlugin&group=type,format=progress)]]
     
    1919== Download
    2020
    21 Download the [download:privatewikiplugin zipped source], check out [/svn/privatewikiplugin using Subversion], or [source:privatewikiplugin browse the source] with Trac.
     21Download the zipped source from [export:privatewikiplugin here].
     22
     23== Source
     24
     25Check out [/svn/privatewikiplugin using Subversion], or [source:privatewikiplugin browse the source] with Trac.
    2226
    2327== Installation
    2428
    25  1. Install the plugin, either for a single project or globally. See the details on how to install a trac plugin at: [trac:TracPlugins]
    26 
    27  ''Latest Development Branch:''
     29 1. Install the plugin, either for a single project or globally. See the details on how to install a trac plugin at [trac:TracPlugins]. For the latest development branch:
    2830 {{{#!sh
    2931easy_install https://trac-hacks.org/svn/privatewikiplugin/trunk/
    30  }}}
    31  2. Be sure that the plugin is enabled: add `privatewiki.api.privatewikisystem = enabled` to `trac.ini` (in the `[components]` subheading). Alternatively, this can be enabled in the Web Admin section of your Trac installation.
    32  3. In `trac.ini` modify the `permission_policies` to include `PrivateWikiSystem` before the default entries (order is important!). If permission policies from other plugins are used, care will need to be taken to ensure the correct order. If `AuthzPolicy` is used to implement TracFineGrainedPermissions, then the order is most likely `AuthzPolicy, PrivateWikiSystem, DefaultPermissionPolicy, LegacyAttachmentPolicy`.
     32}}}
     33 1. Be sure that the plugin is enabled: add `privatewiki.api.privatewikisystem = enabled` to `trac.ini` in the `[components]` subheading. Alternatively, this can be enabled in the Web Admin section of your Trac installation.
     34 1. In `trac.ini` modify the `permission_policies` to include `PrivateWikiSystem` before the default entries (order is important!). If permission policies from other plugins are used, care will need to be taken to ensure the correct order. If `AuthzPolicy` is used to implement TracFineGrainedPermissions, then the order is most likely `AuthzPolicy, PrivateWikiSystem, DefaultPermissionPolicy, LegacyAttachmentPolicy`.
    3335
    3436 Before:
    35 {{{
    36 #!ini
     37{{{#!ini
    3738[trac]
    3839permission_policies = DefaultPermissionPolicy, LegacyAttachmentPolicy
    3940}}}
     41
    4042 After:
    41 {{{
    42 #!ini
     43{{{#!ini
    4344[trac]
    4445permission_policies = PrivateWikiSystem, DefaultPermissionPolicy, LegacyAttachmentPolicy
     
    4950In `trac.ini` add a `privatewikis` section, under that add a private_wikis field and list the Pages that you want to protect. Enter the pages in all upper case and replace /'s with _:
    5051
    51 {{{
    52 #!ini
     52{{{#!ini
    5353[privatewikis]
    5454private_wikis = IT,FOOBAR,FOOBAR_INFO
    5555}}}
    5656
    57 Once you've added this you will have some new permissions in the admin section.  For example you'll have PRIVATE_VIEW_FOO and PRIVATE_EDIT_FOO_BAR which will control which users can view or edit !FooBar and anything below it like !FooBar/Test. The downside is that this plugin sees !FooBar and Foobar as the same page so any restrictions on one will restrict the access of the other.
     57Once you have added this you will have some new permissions in the admin section. For example you will have PRIVATE_VIEW_FOO and PRIVATE_EDIT_FOO_BAR which will control which users can view or edit !FooBar and anything below it like !FooBar/Test. The downside is that this plugin sees Foo'''B'''ar and Foo'''b'''ar as the same page, so any restrictions on one will restrict the access of the other.
    5858
    5959== Recent Changes