annotate examples/trac/wiki-default/TracPermissions @ 39:71ecbe90aafc

Copy Trac to main branch.
author cmlenz
date Mon, 03 Jul 2006 18:53:27 +0000
parents
children
rev   line source
39
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
1 = Trac Permissions =
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
2 [[TracGuideToc]]
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
3
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
4 Trac uses a simple but flexible permission system to control what users can and can't access.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
5
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
6 Permission privileges are managed using the [wiki:TracAdmin trac-admin] tool.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
7
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
8 Regular visitors, non-authenticated users, accessing the system are assigned the default
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
9 role (''user'') named {{{anonymous}}}.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
10 Assign permissions to the {{{anonymous}}} user to set privileges for non-authenticated/guest users.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
11
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
12 In addition to these privileges users can be granted additional individual
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
13 rights in effect when authenticated and logged into the system.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
14
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
15 == Available Privileges ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
16
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
17 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 let you do anything you want.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
18
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
19 Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
20
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
21 === Repository Browser ===
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
22
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
23 || `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
24 || `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
25 || `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
26 || `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
27
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
28 === Ticket System ===
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
29
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
30 || `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
31 || `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
32 || `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
33 || `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
34 || `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
35 || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments. ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
36
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
37 === Roadmap ===
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
38
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
39 || `MILESTONE_VIEW` || View a milestone ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
40 || `MILESTONE_CREATE` || Create a new milestone ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
41 || `MILESTONE_MODIFY` || Modify existing milestones ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
42 || `MILESTONE_DELETE` || Delete milestones ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
43 || `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
44 || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
45 || `ROADMAP_ADMIN` || Alias for `MILESTONE_ADMIN` (deprecated) ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
46
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
47 === Reports ===
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
48
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
49 || `REPORT_VIEW` || View [wiki:TracReports reports] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
50 || `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
51 || `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
52 || `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
53 || `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
54 || `REPORT_ADMIN` || All `REPORT_*` permissions ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
55
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
56 === Wiki System ===
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
57
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
58 || `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
59 || `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
60 || `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
61 || `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
62 || `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
63
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
64 === Others ===
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
65
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
66 || `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
67 || `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
68 || `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
69
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
70 == Granting Privileges ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
71
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
72 Currently the only way to grant privileges to users is by using the `trac-admin` script. The current set of privileges can be listed with the following command:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
73 {{{
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
74 $ trac-admin /path/to/projenv permission list
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
75 }}}
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
76
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
77 This command will allow the user ''bob'' to delete reports:
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
78 {{{
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
79 $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
80 }}}
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
81
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
82 == Permission Groups ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
83
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
84 Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
85 {{{
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
86 $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
87 $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
88 $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
89 $ trac-admin /path/to/projenv permission add bob developer
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
90 $ trac-admin /path/to/projenv permission add john developer
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
91 }}}
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
92
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
93 == Default Permissions ==
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
94
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
95 Granting privileges to the special user ''anonymous'' can be used to control what an anonymous user can do before they have logged in.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
96
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
97 In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
98
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
99 ----
71ecbe90aafc Copy Trac to main branch.
cmlenz
parents:
diff changeset
100 See also: TracAdmin, TracGuide
Copyright (C) 2012-2017 Edgewall Software