Edgewall Software

Changes between Initial Version and Version 1 of 0.10/TracPermissions


Ignore:
Timestamp:
Dec 6, 2007, 1:59:18 PM (14 years ago)
Author:
Christian Boos
Comment:

Copy of TracPermissions@51

Legend:

Unmodified
Added
Removed
Modified
  • 0.10/TracPermissions

    v1 v1  
     1= Trac Permissions =
     2[[TracGuideToc]]
     3
     4Trac uses a simple permission system to control what users can and can't access.
     5
     6Permission privileges are managed using either the [wiki:TracAdmin trac-admin] tool from the command line or the new (in version 0.11) ''Admin'' tab.
     7
     8Non-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.
     9In 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".
     10
     11== Graphical Admin Tab ==
     12''This feature is new in version 0.11.''
     13
     14To access this tab, a user must have `TRAC_ADMIN privileges`. This can be performed as follows (more on the trac-admin script below):
     15{{{
     16  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     17}}}
     18
     19Then, the user will be able to see the Admin tab, and can then access the permissions menu. This menu will allow you to perform all the following actions, but from the browser without requiring root access to the server (just the correct permissions for your user account).
     20
     21 1. [[Image(admin.png)]]
     22 1. [[Image(permissions.png)]]
     23 1. [[Image(ticket_admin.png)]]
     24
     25
     26== Available Privileges ==
     27
     28To enable all privileges for a user, use the `TRAC_ADMIN` permission. This will also give them access to the ''Admin'' tab on the browser view. Having `TRAC_ADMIN` is like being `root` on a *NIX system: it will allow you to perform any operation.
     29
     30Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
     31
     32=== Repository Browser ===
     33
     34|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
     35|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
     36|| `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
     37|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
     38
     39=== Ticket System ===
     40
     41|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
     42|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
     43|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
     44|| `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field ||
     45|| `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] ||
     46|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||
     47
     48Attention: the `REPORT_VIEW` permission is necessary to show the "view tickets" link.
     49
     50=== Roadmap ===
     51
     52|| `MILESTONE_VIEW` || View a milestone ||
     53|| `MILESTONE_CREATE` || Create a new milestone ||
     54|| `MILESTONE_MODIFY` || Modify existing milestones ||
     55|| `MILESTONE_DELETE` || Delete milestones ||
     56|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
     57|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page ||
     58
     59=== Reports ===
     60
     61|| `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link ||
     62|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
     63|| `REPORT_CREATE` || Create new [wiki:TracReports reports] (Create report & save query buttons not shown)||
     64|| `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
     65|| `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
     66|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
     67
     68=== Wiki System ===
     69
     70|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
     71|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
     72|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
     73|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
     74|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
     75
     76=== Others ===
     77
     78|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
     79|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
     80|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
     81|| `EMAIL_VIEW` || ??? ||
     82
     83== Granting Privileges ==
     84
     85You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
     86{{{
     87  $ trac-admin /path/to/projenv permission list
     88}}}
     89
     90This command will allow the user ''bob'' to delete reports:
     91{{{
     92  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
     93}}}
     94
     95The `permission add` command also accepts multiple privilege names:
     96{{{
     97  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
     98}}}
     99
     100Or add all privileges:
     101{{{
     102  $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
     103}}}
     104
     105== Permission Groups ==
     106
     107There are two built-in groups, "authenticated" and "anonymous".[[BR]]
     108Any user who has not logged in is automatically in the "anonymous" group.[[BR]]
     109Any user who has logged in is also in the "authenticated" group.[[BR]]
     110The "authenticated" group inherits permissions from the "anonymous" group.[[BR]]
     111eg. if the "anonymous" group has permission WIKI_MODIFY, it's not necessary to add the WIKI_MODIFY permisison to the "authenticated" group as well.
     112
     113Custom groups may be defined that inherit permissions from the two built-in groups.
     114
     115Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
     116{{{
     117  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
     118  $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
     119  $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
     120  $ trac-admin /path/to/projenv permission add bob developer
     121  $ trac-admin /path/to/projenv permission add john developer
     122}}}
     123
     124Group 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'''.
     125
     126== Adding a New Group and Permissions ==
     127Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
     128
     129The 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)
     130{{{
     131   $ trac-admin /path/to/projenv permission add bob beta_testers
     132   $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
     133
     134}}}
     135
     136== Removing Permissions ==
     137
     138Permissions can be removed using the 'remove' command. For example:
     139
     140This command will prevent the user ''bob'' from deleting reports:
     141{{{
     142  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     143}}}
     144
     145Just like `permission add`, this command accepts multiple privilege names.
     146
     147You can also remove all privileges for a specific user:
     148{{{
     149  $ trac-admin /path/to/projenv permission remove bob '*'
     150}}}
     151
     152Or one privilege for all users:
     153{{{
     154  $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     155}}}
     156
     157== Default Permissions ==
     158
     159By 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''.
     160
     161----
     162See also: TracAdmin, TracGuide and [http://trac.edgewall.org/wiki/FineGrainedPermissions FineGrainedPermissions]