Documentation / move user reset password to it's own page and content…

… improvements
geonetwork · Nov 28, 2024 · b9d71be · b9d71be
1 parent fc6fefe
commit b9d71be
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 38 deletions.
diff --git a/...nual/docs/administrator-guide/managing-users-and-groups/img/password-forgot.png b/...nual/docs/administrator-guide/managing-users-and-groups/img/password-forgot.png
diff --git a/...cs/administrator-guide/managing-users-and-groups/img/selfregistration-start.png b/...cs/administrator-guide/managing-users-and-groups/img/selfregistration-start.png
diff --git a/docs/manual/docs/administrator-guide/managing-users-and-groups/index.md b/docs/manual/docs/administrator-guide/managing-users-and-groups/index.md
@@ -3,6 +3,7 @@
 -   [Creating group](creating-group.md)
 -   [Creating user](creating-user.md)
 -   [User Self-Registration](user-self-registration.md)
+-   [User reset password](user-reset-password.md)
 -   [Authentication mode](authentication-mode.md)
 
 ## Default user {#user-defaults}

diff --git a/...anual/docs/administrator-guide/managing-users-and-groups/user-reset-password.md b/...anual/docs/administrator-guide/managing-users-and-groups/user-reset-password.md
@@ -0,0 +1,36 @@
+# User 'Forgot your password?' function {#user_forgot_password}
+
+!!! note
+    This function requires an email server configured. See [System configuration](../configuring-the-catalog/system-configuration.md#system-config-feedback).
+
+This function allows users who have forgotten their password to request a new one. Go to the sign in page to access the form:
+
+![](img/password-forgot.png)
+
+If a user takes this option they will receive an email inviting them to change their password as follows:
+
+    You have requested to change your Greenhouse GeoNetwork Site password.
+
+    You can change your password using the following link:
+
+    http://localhost:8080/geonetwork/srv/en/[email protected]&changeKey=635d6c84ddda782a9b6ca9dda0f568b011bb7733
+
+    This link is valid for today only.
+
+    Greenhouse GeoNetwork Site
+
+The catalog has generated a changeKey from the forgotten password and the current date and emailed that to the user as part of a link to a change password form.
+
+If you want to change the content of this email, you should modify `xslt/service/account/password-forgotten-email.xsl`.
+
+When the user clicks on the link, a change password form is displayed in their browser and a new password can be entered. When that form is submitted, the changeKey is regenerated and checked with the changeKey supplied in the link, if they match then the password is changed to the new password supplied by the user.
+
+The final step in this process is a verification email sent to the email address of the user confirming that a change of password has taken place:
+
+    Your Greenhouse GeoNetwork Site password has been changed.
+
+    If you did not change this password contact the Greenhouse GeoNetwork Site helpdesk
+
+    The Greenhouse GeoNetwork Site team
+
+If you want to change the content of this email, you should modify `xslt/service/account/password-changed-email.xsl`.
diff --git a/...al/docs/administrator-guide/managing-users-and-groups/user-self-registration.md b/...al/docs/administrator-guide/managing-users-and-groups/user-self-registration.md
@@ -1,5 +1,9 @@
 # User Self-Registration {#user_self_registration}
 
+!!! note
+    This function requires an email server configured. See [System configuration](../configuring-the-catalog/system-configuration.md#system-config-feedback).
+
+
 To enable the self-registration functions, see [System configuration](../configuring-the-catalog/system-configuration.md). When self-registration is enabled, for users that are not logged in, an additional link is shown on the login page:
 
 ![](img/selfregistration-start.png)
@@ -15,8 +19,8 @@ The fields in this form are self-explanatory except for the following:
     -   the user will still be given the `Registered User` profile
     -   an email will be sent to the Email address nominated in the Feedback section of the 'System Administration' menu, informing them of the request for a more privileged profile
 -   **Requested group**: By default, self-registered users are not assigned to any group. If a group is selected:
-  -   the user will still not be assigned to any group
-  -   an email will be sent to the Email address nominated in the Feedback section of the 'System Administration' menu, informing them of the requested group.
+    -   the user will still not be assigned to any group
+    -   an email will be sent to the Email address nominated in the Feedback section of the 'System Administration' menu, informing them of the requested group.
 
 ## What happens when a user self-registers?
 
@@ -72,39 +76,3 @@ If you want to change the content of this email, you should modify `xslt/service
     The Greenhouse GeoNetwork Site
 
 If you want to change the content of this email, you should modify `xslt/service/account/registration-prof-email.xsl`.
-
-## The 'Forgot your password?' function
-
-This function allows users who have forgotten their password to request a new one. Go to the sign in page to access the form:
-
-![](img/password-forgot.png)
-
-For security reasons, only users that have the `Registered User` profile can request a new password.
-
-If a user takes this option they will receive an email inviting them to change their password as follows:
-
-    You have requested to change your Greenhouse GeoNetwork Site password.
-
-    You can change your password using the following link:
-
-    http://localhost:8080/geonetwork/srv/en/[email protected]&changeKey=635d6c84ddda782a9b6ca9dda0f568b011bb7733
-
-    This link is valid for today only.
-
-    Greenhouse GeoNetwork Site
-
-The catalog has generated a changeKey from the forgotten password and the current date and emailed that to the user as part of a link to a change password form.
-
-If you want to change the content of this email, you should modify `xslt/service/account/password-forgotten-email.xsl`.
-
-When the user clicks on the link, a change password form is displayed in their browser and a new password can be entered. When that form is submitted, the changeKey is regenerated and checked with the changeKey supplied in the link, if they match then the password is changed to the new password supplied by the user.
-
-The final step in this process is a verification email sent to the email address of the user confirming that a change of password has taken place:
-
-    Your Greenhouse GeoNetwork Site password has been changed.
-
-    If you did not change this password contact the Greenhouse GeoNetwork Site helpdesk
-
-    The Greenhouse GeoNetwork Site team
-
-If you want to change the content of this email, you should modify `xslt/service/account/password-changed-email.xsl`.
diff --git a/docs/manual/mkdocs.yml b/docs/manual/mkdocs.yml
@@ -323,6 +323,7 @@ nav:
         - administrator-guide/managing-users-and-groups/creating-group.md
         - administrator-guide/managing-users-and-groups/creating-user.md
         - administrator-guide/managing-users-and-groups/user-self-registration.md
+        - administrator-guide/managing-users-and-groups/user-reset-password.md
       - 'Classification Systems':
         - administrator-guide/managing-classification-systems/index.md
         - administrator-guide/managing-classification-systems/managing-categories.md