Published

Repoint the User Authentication backlinks at the new documentation tree

Last modified by Eleni Cojocariu on 2026/08/10 23:36

Step 4 of the conversion merged in Convert the User Authentication documentation into the documentation tree: the pages that link into the content which moved to documentation.xs.admin.authentication now link at it directly, instead of going through the stripped Documentation.AdminGuide.Authentication pointer page.

Six of that page's twelve backlinks are prose links into moved content, and they are the ones changed here:

PageNow points at
Documentation.AdminGuide.ConfigurationUser Authentication
Documentation.AdminGuide.SecurityAuthentication Parameters
Documentation.AdminGuide (the Main Topics card)User Authentication
Documentation.UserGuide.Features.AuthenticationCustomize the Authentication Mail Templates (twice), User Authentication
documentation.extensions.admin.llm.mcp-server.configureSelect the Authenticator
documentation.xs.admin.instance-cloningUser Authentication

Three of those links carried an anchor into a section that the strip removed (#HMailTemplates, #HAuthenticationparameters, #HChoosetheauthenticator), so they were already landing at the top of the pointer page. They now land on the page that holds the content.

The remaining six backlinks are deliberately left alone: the two release-note entries and the cristal.xwiki.org page are dated historical records, and the three extensions.xwiki.org pages link the extension in order to install it, which is what those pages are for.

Only the content of each page is changed — no title, no xobject.

All changes

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ThomasMortagne
1 +XWiki.elenicojocariu
Content
... ... @@ -1,3 +1,4 @@
1 +
1 1  {{box cssClass="floatinginfobox" title="**Contents**"}}
2 2  {{toc/}}
3 3  {{/box}}
... ... @@ -155,7 +155,7 @@
155 155  
156 156  = User Authentication =
157 157  
158 -See the [[Authentication Guide>>Documentation.AdminGuide.Authentication.WebHome]].
159 +See the [[User Authentication documentation>>documentation.xs.admin.authentication.WebHome]].
159 159  
160 160  == Customizing the Verified Registration Page ==
161 161  

Summary

Details

Page properties
Content
... ... @@ -1,3 +1,4 @@
1 +
1 1  This page aims at listing the various security aspects an administrator needs to be aware of when dealing with XWiki. For all security decision a developer needs to take when writing scripts and extensions, you should have a look to [[the security page of the developer guide>>Documentation.DevGuide.Security.WebHome]].
2 2  
3 3  {{box cssClass="floatinginfobox" title="**Contents**"}}
... ... @@ -90,7 +90,7 @@
90 90  * //xwiki.authentication.encryptionKey//
91 91  {{/version}}
92 92  
93 -See the [[Authentication parameters section>>Documentation.AdminGuide.Authentication.WebHome#HAuthenticationparameters]] for more details.
94 +See the [[Authentication Parameters>>documentation.xs.admin.authentication.parameters.WebHome]] page for more details.
94 94  
95 95  === Encrypt cookies using IP address ===
96 96  

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.enygma
1 +XWiki.elenicojocariu
Content
... ... @@ -1,3 +1,4 @@
1 +
1 1  {{velocity output="false"}}
2 2  $xwiki.ssx.use('xwiki:Documentation.WebHome')
3 3  {{/velocity}}
... ... @@ -66,7 +66,7 @@
66 66  (((
67 67  (% class="card-title" %)
68 68  (((
69 -===== [[Documentation.AdminGuide.Authentication.WebHome]] =====
70 +===== [[documentation.xs.admin.authentication.WebHome]] =====
70 70  )))
71 71  
72 72  (% class="card-subtitle mb-2" %)

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ThomasMortagne
1 +XWiki.elenicojocariu
Content
... ... @@ -1,3 +1,4 @@
1 +
1 1  {{box cssClass="floatinginfobox" title="**Contents**"}}
2 2  {{toc/}}
3 3  {{/box}}
... ... @@ -14,7 +14,7 @@
14 14  
15 15  {{image reference="login-forgot-username-1"/}}
16 16  
17 -Then, you'll need to indicate the email address for your user and you'll be emailed your username (the mail template can be [[customized>>Documentation.AdminGuide.Authentication.WebHome#HMailTemplates]]).
18 +Then, you'll need to indicate the email address for your user and you'll be emailed your username (the mail template can be [[customized>>documentation.xs.admin.authentication.customize-mail-templates.WebHome]]).
18 18  
19 19  {{image reference="login-forgot-username-2"/}}
20 20  
... ... @@ -24,7 +24,7 @@
24 24  
25 25  {{image reference="login-forgot-password-1"/}}
26 26  
27 -Then, you'll need to indicate your username and if you had an email address set for your user, you'll receive a email with a link to set a new password (the mail template can be [[customized>>Documentation.AdminGuide.Authentication.WebHome#HMailTemplates]]).
28 +Then, you'll need to indicate your username and if you had an email address set for your user, you'll receive a email with a link to set a new password (the mail template can be [[customized>>documentation.xs.admin.authentication.customize-mail-templates.WebHome]]).
28 28  
29 29  {{image reference="login-forgot-password-2"/}}
30 30  
... ... @@ -59,4 +59,4 @@
59 59  {{/velocity}}
60 60  {{/info}}
61 61  
62 -For more details on how to configure authentication check the [[Authentication page of the Administration Guide>>Documentation.AdminGuide.Authentication]].
63 +For more details on how to configure authentication check the [[User Authentication documentation>>documentation.xs.admin.authentication.WebHome]].
login-forgot-username-2.png
Size
... ... @@ -1,1 +1,1 @@
1 -34.8 KB
1 +26.5 KB
Content
login.png
Size
... ... @@ -1,1 +1,1 @@
1 -34.6 KB
1 +27.9 KB
Content

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.gabrielc
1 +XWiki.elenicojocariu
Content
... ... @@ -1,3 +1,4 @@
1 +
1 1  In the wiki's administration, under "MCP Server":
2 2  
3 3  1. Server name - the name advertised to connecting agents (defaults to the wiki pretty name).
... ... @@ -19,7 +19,7 @@
19 19  
20 20  1. Install the [[OpenID Connect Provider>>doc:extensions:Extension.OpenID Connect.OpenID Connect Provider.WebHome]] extension.
21 21  1. In Administration > Users & Rights > OpenID Connect, change the clients to "Dynamic mode".
22 -1. In Administration > Users & Rights > Authentication, change the authenticator to "Token based authenticator" (see "[[Choose the authenticator>>doc:Documentation.AdminGuide.Authentication.WebHome||anchor="HChoosetheauthenticator"]]").
23 +1. In Administration > Users & Rights > Authentication, change the authenticator to "Token based authenticator" (see "[[Select the Authenticator>>doc:documentation.xs.admin.authentication.select-authenticator.WebHome]]").
23 23  1. If needed, set up a fallback authenticator (see the [[OpenID Connect Provider>>doc:extensions:Extension.OpenID Connect.OpenID Connect Provider.WebHome||anchor="HToken-basedaccess"]] documentation).
24 24  
25 25  {{gallery}}

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Instance Cloning
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.xs.admin.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +XWiki.elenicojocariu
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,0 +1,21 @@
1 +
2 +{{warning}}
3 +WIP
4 +{{/warning}}
5 +
6 +Cloning means making a full, independent copy of an XWiki instance. A common case is copying a live instance to a separate environment to test changes safely before they go live, but the same steps apply any time you need an independent copy, whatever you call the two instances.
7 +
8 +The base procedure is the same as a [[Back Up and Restore>>Documentation.AdminGuide.Backup]] (copy the database and the permanent directory from the source instance to the target instance). However, cloning also requires updating a few instance- and environment-specific settings. Simply copying everything as-is would cause the cloned instance to behave like the original rather than as an independent instance.
9 +
10 +=== The instance id ===
11 +
12 +Each XWiki instance has its own id, stored as the only row in the ##xwikiid## database table. There are multiple methods of [[getting the instance Id>>doc:documentation.xs.dev.instance.get-instance-id.WebHome]] if needed. The target instance must keep its own id, not inherit the source's, so exclude the ##xwikiid## table when restoring the database. XWiki instances using [[non-bundled paid extensions licenses>>https://store.xwiki.com/xwiki/bin/view/Main/WebHome]] are tied to the instance id. Since the id isn't copied, the target instance needs to reload its licenses after the restore, see [[Clone an XWiki Instance>>doc:.clone-instance.WebHome]].
13 +
14 +=== Configuration and settings ===
15 +
16 +Settings in ##xwiki.cfg##, ##xwiki.properties##, and the XWiki Administration (e.g., [[mail sending>>extensions:Extension.Mail.MailApplication]], and any extension that connects to an external service) often contain values specific to one environment, a domain name, or a third-party service address. A backup/restore doesn't adjust these automatically, so review and update them on the target instance. The XWiki server's domain name is stored on the wiki itself, in the Alias property of the ##XWiki.XWikiServerXwiki## page. It's restored unchanged with the rest of the database, so set it to the target instance's own domain afterwards.
17 +
18 +=== Authentication ===
19 +
20 +Authentication needs extra care in one case: when the target instance must use a [[different identity provider>>documentation.xs.admin.authentication.WebHome]] (or a different client configuration of the same provider) than the source. In that case, existing user profiles no longer match after cloning, because the login system can't recognize them. This has its own procedure: [[Preserve User Profiles When Cloning to a Different Identity Provider>>documentation.xs.admin.WebHome]]. If authentication settings block login right after cloning, use the [[superadmin account>>Documentation.AdminGuide.Security||anchor="HSuperadminaccount"]] as a fallback to fix the configuration from inside the wiki.
21 +
DocApp.Code.DocumentationClass[0]
FAQ
... ... @@ -1,0 +1,7 @@
1 +== Why exclude xwikiid instead of just copying everything? ==
2 +
3 +Because it identifies one specific instance. Copying it would make the clone share an identity with the source instead of being independent.
4 +
5 +== Do I need the identity-provider procedure if both instances use the same provider? ==
6 +
7 +No. [[Preserve User Profiles When Cloning to a Different Identity Provider>>doc:.preserve-user-profiles-cloning-different-identity-provider.WebHome]] only applies when the target instance's identity provider or client configuration is different from the source's.
Related
... ... @@ -1,0 +1,1 @@
1 +* [[Multi-tenancy>>Documentation.AdminGuide.Virtualization.WebHome]].
Target
... ... @@ -1,0 +1,1 @@
1 +administrator
Type
... ... @@ -1,0 +1,1 @@
1 +explanation
DocApp.Code.DocumentationExtensionClass[0]
Aug 10, 2026, 11:36:07 PM

Approved by Eleni Cojocariu

Approvers

Approvers have not been explicitly defined for this Change Request. Approvers will be based entirely on approval rights.

Get Connected