This page documents the 0.11 release. Documentation for other releases can be found here.
Table of Contents
Trac uses a simple, case sensitive, permission system to control what users can and can't access.
Permission privileges are managed using the trac-admin tool.
Non-authenticated users accessing the system are assigned the name "anonymous". Assign permissions to the "anonymous" user to set privileges for anonymous/guest users. The parts of Trac that a user does not have the privileges for will not be displayed in the navigation. In addition to these privileges, users can be granted additional individual rights in effect when authenticated and logged into the system. All logged in users belong to the virtual group "authenticated", which inherits permissions from "anonymous".
To enable all privileges for a user, use the
TRAC_ADMIN permission. Having
TRAC_ADMIN is like being
root on a *NIX system: it will allow you to perform any operation.
Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac (note that the privilege names are case-sensitive):
| ||View directory listings in the repository browser|
| ||View revision logs of files and directories in the repository browser|
| ||View files in the repository browser|
| ||View repository check-ins|
| ||View existing tickets and perform ticket queries|
| ||Create new tickets|
| ||Add comments or attachments to tickets|
| ||Modify ticket properties (priority, assignment, keywords, etc.) except description field|
| || Includes both |
| || All |
Attention: the "view tickets" button appears with the
| ||View a milestone|
| ||Create a new milestone|
| ||Modify existing milestones|
| ||Delete milestones|
| || All |
| ||View the roadmap page, is not (yet) the same as MILESTONE_VIEW, see #4292|
| ||to be removed with #3022, replaced by MILESTONE_ADMIN|
| ||View reports, i.e. the "view tickets" link.|
| ||View the underlying SQL query of a report|
| ||Create new reports|
| ||Modify existing reports|
| ||Delete reports|
| || All |
| ||View existing wiki pages|
| ||Create new wiki pages|
| ||Change wiki pages|
| ||Delete wiki pages and attachments|
| || All |
| ||add/grant a permission|
| ||remove/revoke a permission|
| || All |
| ||View the timeline page|
| ||View and execute search queries|
| ||Enables additional pages on About Trac that show the current configuration or the list of installed plugins|
| ||Shows email addresses even if `trac show_email_addresses` configuration optoin is `false`|
Creating New Privileges
To add permissions to Trac 0.11 you simply need to add a myPermissions.py file to your Trac environment plugin folder that looks like this:
from trac.core import Component, implements from trac.perm import IPermissionRequestor class MyPermissions(Component): implements(IPermissionRequestor) def get_permission_actions(self): #comma separated list of new permissions return ('TICKET_CLOSE','TICKET_DEFER')
Add your set of permissions to the return command in place of 'MY_FIRST_PERM', 'MY_SECOND_PERM', restart apache and you should be away.
You can now use these permission in your work flow against actionname.permissions entries.
NOTE: you don't need to call the file "myPermissions.py" - its just needs to be a python file with a name of your choosing.
You grant privileges to users using trac-admin. The current set of privileges can be listed with the following command:
$ trac-admin /path/to/projenv permission list
This command will allow the user bob to delete reports:
$ trac-admin /path/to/projenv permission add bob REPORT_DELETE
permission add command also accepts multiple privilege names:
$ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
Or add all privileges:
$ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
There are two built-in groups, "authenticated" and "anonymous".
Any user who has not logged in is automatically in the "anonymous" group.
Any user who has logged in is also in the "authenticated" group.
The "authenticated" group inherits permissions from the "anonymous" group.
eg. if the "anonymous" group has permission WIKI_MODIFY, it's not necessary to add the WIKI_MODIFY permisison to the "authenticated" group as well.
Custom groups may be defined that inherit permissions from the two built-in groups.
Permissions can be grouped together to form roles such as developer, admin, etc.
$ trac-admin /path/to/projenv permission add developer WIKI_ADMIN $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY $ trac-admin /path/to/projenv permission add bob developer $ trac-admin /path/to/projenv permission add john developer
Group membership can be checked by doing a
permission list with no further arguments; the resulting output will include group memberships. Use lowercase for group names, as uppercase is reserved for permissions.
Adding a New Group and Permissions
Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
The following will add bob to the new group called beta_testers and then will assign WIKI_ADMIN permissions to that group. (Thus, bob will inherit the WIKI_ADMIN permission)
$ trac-admin /path/to/projenv permission add bob beta_testers $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
Permissions can be removed using the 'remove' command. For example:
This command will prevent the user bob from deleting reports:
$ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
permission add, this command accepts multiple privilege names.
You can also remove all privileges for a specific user:
$ trac-admin /path/to/projenv permission remove bob '*'
Or one privilege for all users:
$ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
By default on a new Trac installation, the
anonymous user will have view access to everything in Trac, and will also have permissions to create and modify tickets and wiki pages.
BROWSER_VIEW CHANGESET_VIEW FILE_VIEW LOG_VIEW MILESTONE_VIEW REPORT_SQL_VIEW REPORT_VIEW ROADMAP_VIEW SEARCH_VIEW TICKET_VIEW TIMELINE_VIEW WIKI_VIEW
TICKET_CREATE TICKET_MODIFY WIKI_CREATE WIKI_MODIFY