Wiki source code of User Management
Last modified by Lucas Charpentier (Sereza7) on 2024/11/07
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
2 | {{toc/}} | ||
3 | {{/box}} | ||
4 | |||
5 | = Adding users to your wiki = | ||
6 | |||
7 | 1. Log in as an administrator | ||
8 | 1. Hover over "Wiki" and click on "Administer Wiki" | ||
9 | 1. Click on the "Users" link to bring up an overview of all the users | ||
10 | 1. Click on the "Add new user" button to open a registration page as shown on the image below | ||
11 | 1. Fill in the user information | ||
12 | 1. Click "Save":((( | ||
13 | {{image reference="AddUser.png"/}} | ||
14 | ))) | ||
15 | |||
16 | = Changing a user's password = | ||
17 | |||
18 | == Changing the password for any user == | ||
19 | |||
20 | 1. Log in as an administrator | ||
21 | 1. Open the drawer and click on "User Index" | ||
22 | 1. Click on the name of the user for which you want to change the password (this will take you to the user's profile page) | ||
23 | 1. Click on the "Preferences" tab | ||
24 | 1. Click on the "Change Password" button | ||
25 | 1. Enter the new password twice | ||
26 | 1. Click on the "Update" button((( | ||
27 | {{image reference="ChangePassword.png"/}} | ||
28 | |||
29 | {{warning}} | ||
30 | Don't forget to notify the user! | ||
31 | {{/warning}} | ||
32 | ))) | ||
33 | |||
34 | == Changing the password for the logged in user == | ||
35 | |||
36 | To change your own password follow these steps: | ||
37 | |||
38 | 1. Click on your user avatar in the top right corner of the screen (this will redirect you to your profile) | ||
39 | 1. Click on the "Preferences" tab | ||
40 | 1. Click on the "Change password" button | ||
41 | 1. {{version since="5.1"}}Enter your current password{{/version}} | ||
42 | 1. Enter the new password twice | ||
43 | 1. Click on the "Save" button((( | ||
44 | {{image reference="ChangeOwnPassword.png"/}} | ||
45 | ))) | ||
46 | |||
47 | == Changing the password security policy == | ||
48 | |||
49 | You can define the password security for all the users of the wiki. The policy is defined by some rules available in the Administration > Users & Rights > Registration page. You can specify the minimum length of the password, and if it must contain numbers, lower/upper case characters, and symbol. | ||
50 | |||
51 | {{image reference="password-policy-fields.png"/}} | ||
52 | |||
53 | Please note that when the rules are changed, all further password changes must comply with the new rules, but the older password are still all valid. | ||
54 | |||
55 | = Editing an existing user = | ||
56 | |||
57 | 1. Log in as an administrator | ||
58 | 1. Hover over "Wiki" and click on "Administer Wiki" | ||
59 | 1. Click on the "Users" link to bring up an overview of all the users | ||
60 | 1. You have two options: | ||
61 | 11. Click the user name for the user you want to edit | ||
62 | 11*. On the user's profile page click on the small yellow pencil corresponding to the information you want to edit (profile or preferences) | ||
63 | 11*. Click "Save and View" to save the changes you have made | ||
64 | 11. Click on the small yellow pencil near the user you want to edit (this will open up a lightbox with the main information of that user) | ||
65 | 11*. Make your modifications and click "Save"((( | ||
66 | {{info}} | ||
67 | There is also a link to the complete user profile, where you can proceed as above (first option). | ||
68 | {{/info}} | ||
69 | |||
70 | {{image reference="EditUserProfile.png" width="580px"/}} | ||
71 | ))) | ||
72 | |||
73 | = Deleting a user = | ||
74 | |||
75 | 1. Log in as an administrator | ||
76 | 1. Go to the User section of the Wiki administration | ||
77 | 1. Delete the user by clicking the red "X" corresponding to the user you want to delete (the user will be automatically removed from all the groups it belonged to)((( | ||
78 | {{info}} | ||
79 | You won't be able to delete the currently logged in user and you'll need to log-in using other credentials. This is done in order to prevent mistakes. | ||
80 | {{/info}} | ||
81 | |||
82 | [[image:user_administration_disable_account.png||width="960"]] | ||
83 | ))) | ||
84 | |||
85 | = Modify the number of users displayed in the list = | ||
86 | |||
87 | Edit the ##XWiki.AdminUsersSheet## page. It contains a line like this: | ||
88 | |||
89 | {{code}} | ||
90 | var ta = new XWiki.widgets.LiveTable("$url", "userstable", callback); | ||
91 | {{/code}} | ||
92 | |||
93 | Replace it with: | ||
94 | |||
95 | {{code}} | ||
96 | var ta = new XWiki.widgets.LiveTable("$url", "userstable", callback, {limit: 100}); | ||
97 | {{/code}} | ||
98 | |||
99 | where ##100## is the number of items displayed per page. | ||
100 | |||
101 | = Customizing the Registration page = | ||
102 | |||
103 | Customizing the registration page is done by the "Verified Registration" Page, part of the [[Administration Application>>extensions:Extension.Administration Application]]. This provides more features such as captcha and client side validation of user input. For more information about how to configure it, visit the [[application page>>extensions:Extension.Administration Application]]. | ||
104 | |||
105 | In order to customize the registration page you must follow these steps: | ||
106 | |||
107 | 1. Log in as an administrator | ||
108 | 1. Click on the right drawer icon, then click on "Administer Wiki" | ||
109 | 1. Go to "Users & Rights" > "Registration" | ||
110 | 1. Make your modifications and click "Save":((( | ||
111 | {{image reference="Registration.png" width="960px"/}} | ||
112 | ))) | ||
113 | |||
114 | = Enable/Disable User Account = | ||
115 | |||
116 | It is possible to disable a user account and to enable it back from his/her profile. A disabled user is able to login but cannot perform any action once logged-in. | ||
117 | [[image:account-disabled-warning.png||width="960"]] | ||
118 | |||
119 | == From the administration == | ||
120 | |||
121 | [[image:user_administration_disable_account.png||width="960"]] | ||
122 | |||
123 | 1. Log in as an administrator | ||
124 | 1. Go to the User section of the Wiki administration | ||
125 | 1. Click on the closed lock to disable a user | ||
126 | |||
127 | To enable a user, follow the same steps but click on the opened lock. | ||
128 | |||
129 | == From a user profile == | ||
130 | |||
131 | [[image:disable-account.png||width="350"]] | ||
132 | |||
133 | 1. Login an an administrator | ||
134 | 1. Visit a user profile | ||
135 | 1. Click on the "Disable this account" action. | ||
136 | |||
137 | [[image:enable-account.png||width="350"]] | ||
138 | |||
139 | To enable a user, follow the same step but click on the "Enable this account" action. | ||
140 | |||
141 | = Inactive Users = | ||
142 | |||
143 | If you configured the registration page to enable the **Use Email Verification**, then new registered users are by default inactive. The user account is activated by a link on the email. (See more information in [[Administration Application>>extensions:Extension.Administration Application]]). | ||
144 | |||
145 | Inactive users are prevented to get access to most pages of the wiki by default. The pages they can get access to can be configured in the [[configuration>>Documentation.AdminGuide.Configuration#HAllowedPagesforInactiveUsers]]. Prior to that, the ##Authentication Active Check## must be enabled in order for inactive users to get access to the wiki. | ||
146 | |||
147 | = User Storage = | ||
148 | |||
149 | Users are stored inside wiki pages containing an XObject of the ##XWiki.XWikiUsers## XClass. To see all the user metadata, you can navigate to the profile page of a user and edit it using the Object editor. |