~kosova/+junk/tuxfamily-twiki

« back to all changes in this revision

Viewing changes to foswiki/data/System/TopicUserMappingContrib.txt

  • Committer: James Michael DuPont
  • Date: 2009-07-18 19:58:49 UTC
  • Revision ID: jamesmikedupont@gmail.com-20090718195849-vgbmaht2ys791uo2
added foswiki

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
---+!! !TopicUserMappingContrib
 
2
<!--
 
3
One line description, required for extensions repository catalog.
 
4
   * Set SHORTDESCRIPTION = User management using data stored in topics
 
5
-->
 
6
%SHORTDESCRIPTION%
 
7
 
 
8
%TOC%
 
9
 
 
10
The _User Mapping Manager_ interface provides services for mapping between a 'user identity' as used when talking to an external authentication provider,
 
11
an internal canonical user ID, and the displayed name used to identify the user in topics. 
 
12
This is the default <nop>TopicUserMapping in which user information is stored in topics - one per user, and then any mapping needed is done using the
 
13
<nop>WikiUsers topic in the %USERSWEB%.
 
14
 
 
15
See [[http://twiki.org/cgi-bin/view/Codev/SimplifiedUserMappingCodeInterface][SimplifiedUserMappingCodeInterface]] for a more detailed discussion
 
16
of the concepts.
 
17
 
 
18
It includes the topics that are used when registering and managing users and groups via Foswiki:
 
19
   * Registration and user management topics
 
20
      * %SYSTEMWEB%.UserRegistration
 
21
      * %SYSTEMWEB%.ResetPassword
 
22
      * %SYSTEMWEB%.ChangePassword           
 
23
      * %SYSTEMWEB%.ChangeEmailAddress       
 
24
      * %SYSTEMWEB%.BulkRegistration         
 
25
      * %SYSTEMWEB%.BulkResetPassword        
 
26
   * Documentation topics
 
27
      * %SYSTEMWEB%.ManagingUsers            
 
28
      * %SYSTEMWEB%.UserToolsCategory
 
29
      * %SYSTEMWEB%.LoginName                
 
30
   * default groups and user
 
31
      * %USERSWEB%.NobodyGroup
 
32
      * %USERSWEB%.AdminGroup
 
33
      * %USERSWEB%.RegistrationAgent    
 
34
   * User lists
 
35
      * %USERSWEB%.UserList                  
 
36
      * %USERSWEB%.UserListHeader            
 
37
      * %USERSWEB%.UserListByDateJoined      
 
38
      * %USERSWEB%.UserListByLocation        
 
39
      * %USERSWEB%.UserListByPhotograph      
 
40
   * User and Group template files
 
41
      * %SYSTEMWEB%.NewUserTemplate
 
42
      * %SYSTEMWEB%.UserForm
 
43
      * %SYSTEMWEB%.UsersTemplate
 
44
      * %USERSWEB%.UserHomepageHeader        
 
45
      * %SYSTEMWEB%.UserSetting
 
46
      * %USERSWEB%.GroupTemplate        
 
47
 
 
48
If you are developing a non-topic based User mapper, you might like to consider removeing or replacing the files installed by this Contrib.
 
49
 
 
50
---++ Adding and deleting users
 
51
Users are added using the default registration process in Foswiki. To delete a user (admins only),
 
52
 
 
53
   1. Edit the .htpasswd file to delete their entry (see =configure= for the location
 
54
   2. Remove their topic files: data/%USERSWEB%/FredQuimby.txt and data/%USERSWEB%/FredQuimby.txt,v
 
55
   3. Remove the FredQuimby line from the %USERSWEB%.WikiUsers topic
 
56
   4. Remove user from all groups and from all the ALLOWWEB/ALLOWTOPIC... declarations, if any.
 
57
      Note: Otherwise this will leave a security hole, as the first person to re-register with this name will be granted the permissions of the previous user.
 
58
 
 
59
---++ Settings
 
60
The !TopicUserMappingContrib specific settings have not yet been moved out of the standard Foswiki.spec. This will be done in a future release.
 
61
 
 
62
---++ Installation Instructions
 
63
 
 
64
It's a part of the default distribution of the Foswiki Core.
 
65
 
 
66
---++ Contrib Info
 
67
 
 
68
|  Contrib Author(s): | Copyright (C) 2007-2008 Sven Dowideit, SvenDowideit@WikiRing.com and Project Contributors. |
 
69
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
 
70
|  Contrib Version: | 4.2.2 (16 Dec 2008) |
 
71
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
 
72
|  4.2.2 | 16 Dec 2008 - Foswiki version |
 
73
|  4.2.1 | 03 Aug 2008 - Distributed with TWiki 4.2.1 |
 
74
|  4.2.0 | 22 Jan 2008 - Distributed with TWiki 4.2.0 |
 
75
|  Dependencies: | None |
 
76
|  Contrib Home: | http://foswiki.org/Extensions/%TOPIC% |
 
77
|  Support: | http://foswiki.org/Support/%TOPIC% | 
 
78
 
 
79
<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the Dev topic instead. -->