wiki:PrivateWikiPlugin

Version 28 (modified by Ryan J Ollos, 10 years ago) (diff)

Made a note about using other non-default permission_policies.

Restrict Access to sections of the Wiki

Description

Allows you to protect wiki pages against access.

Bugs/Feature Requests

Existing bugs and feature requests for PrivateWikiPlugin are here.

If you have any issues, create a new ticket.

Download

Download the [download:privatewikiplugin zipped source], check out using Subversion, or browse the source with Trac.

Installation Help

  1. Install the plugin (either for a single project, or globally). See the details on how to install a trac plugin at: TracPlugins

Latest Development Branch:

easy_install https://trac-hacks.org/svn/privatewikiplugin/trunk/
  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 the website as well
  2. 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, particular care will need to be taken to ensure the correct order. If AuthzPolicy is used to implement TracFineGrainedPermissions, then the order should most likely be AuthzPolicy, PrivateWikiSystem, DefaultPermissionPolicy, LegacyAttachmentPolicy.

Before:

[trac]
permission_policies = DefaultPermissionPolicy, LegacyAttachmentPolicy

After:

[trac]
permission_policies = PrivateWikiSystem, DefaultPermissionPolicy, LegacyAttachmentPolicy

Use

In 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 _.

[privatewikis]
private_wikis = IT,FOOBAR,FOOBAR_INFO

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.

Recent Changes

17167 by rjollos on 2018-05-09 16:31:10
TracPrivateWiki 1.1.0: Conform to PEP8
16496 by rjollos on 2017-04-15 08:21:36
Fix indentation
16366 by rjollos on 2017-03-22 19:49:49
TracPrivateWiki 1.1.0: Removing special handling of anonymous user

Note: name of permission policy and component rule have changed.
See revised installation instructions when upgrading.

Fixes #11529.

(more)

Author/Contributors

Author: eric256
Maintainer: natewlew
Contributors: