Wiki source code of Administrator Guide

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

Manage
- Copy
Actions
- Export
- Print Preview
Viewers
- Source
- Children
- Content
- Attachments
- History
- Information
- Likes

version	line-number	content
38.1	1
22.1	2	{{velocity output="false"}}
22.4	3	$xwiki.ssx.use('xwiki:Documentation.WebHome')
22.1	4	{{/velocity}}
1.2	5
22.1	6	(% class="row cards" %)
	7	(((
	8	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	9	(((
23.13	10	(% class="card card1" %)
	11	(((
	12	(% class="card-body" %)
	13	(((
24.1	14	==== (% class="card-title" %)[[Installation>>Documentation.AdminGuide.Installation.WebHome]](%%) ====
23.13	15
	16	(% class="card-text" %)
	17	(((
	18	Learn how to install XWiki on your machine or upgrade an existing installation.
22.1	19	)))
23.13	20	)))
	21	)))
	22	)))
	23
22.1	24	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	25	(((
23.13	26	(% class="card card1" %)
	27	(((
	28	(% class="card-body" %)
	29	(((
25.1	30	==== (% class="card-title" %)[[Configuration>>Documentation.AdminGuide.Configuration.WebHome]](%%) ====
23.13	31
	32	(% class="card-text" %)
	33	(((
	34	Learn how to configure and tune XWiki in various ways.
22.1	35	)))
23.13	36	)))
	37	)))
	38	)))
	39
22.1	40	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	41	(((
23.13	42	(% class="card card1" %)
	43	(((
	44	(% class="card-body" %)
	45	(((
23.25	46	==== (% class="card-title" %)[[Upgrade>>Documentation.AdminGuide.Upgrade]](%%) ====
23.13	47
	48	(% class="card-text" %)
	49	(((
	50	Learn how to upgrade your XWiki installation to keep it up-to-date.
22.1	51	)))
	52	)))
23.13	53	)))
	54	)))
	55	)))
	56
22.1	57	== Main Topics ==
	58
	59
	60	(% class="row cards" %)
	61	(((
	62	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	63	(((
23.13	64	(% class="card card2" %)
	65	(((
	66	(% class="card-body" %)
	67	(((
	68	(% class="card-title" %)
	69	(((
38.1	70	===== [[documentation.xs.admin.authentication.WebHome]] =====
22.1	71	)))
	72
23.13	73	(% class="card-subtitle mb-2" %)
	74	(((
	75	====== Configure XWiki's authentication mechanism (Database, LDAP, custom implementation, etc). ======
	76	)))
	77	)))
	78	)))
	79	)))
	80
22.1	81	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	82	(((
23.13	83	(% class="card card2" %)
	84	(((
	85	(% class="card-body" %)
	86	(((
	87	(% class="card-title" %)
	88	(((
23.25	89	===== [[Documentation.AdminGuide.User Management]] =====
22.1	90	)))
	91
23.13	92	(% class="card-subtitle mb-2" %)
	93	(((
	94	====== Add, Edit, Delete and manage users. ======
	95	)))
	96	)))
	97	)))
	98	)))
	99
22.1	100	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	101	(((
23.13	102	(% class="card card2" %)
	103	(((
	104	(% class="card-body" %)
	105	(((
	106	(% class="card-title" %)
	107	(((
26.1	108	===== [[Documentation.AdminGuide.Access Rights.WebHome]] =====
22.1	109	)))
23.13	110
	111	(% class="card-subtitle mb-2" %)
	112	(((
	113	====== Define which users should be allowed to view and interact with your wiki. ======
22.1	114	)))
23.13	115	)))
	116	)))
	117	)))
	118	)))
	119
22.1	120	(% class="hidden-xs" %)
	121	----
	122
	123	(% class="row cards" %)
	124	(((
	125	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	126	(((
23.13	127	(% class="card card2" %)
	128	(((
	129	(% class="card-body" %)
	130	(((
	131	(% class="card-title" %)
	132	(((
23.25	133	===== [[Import/Export>>Documentation.AdminGuide.ImportExport]] =====
22.1	134	)))
	135
23.13	136	(% class="card-subtitle mb-2" %)
	137	(((
	138	====== Import and Export pages to and from your wikis. ======
	139	)))
	140	)))
	141	)))
	142	)))
	143
22.1	144	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	145	(((
23.13	146	(% class="card card2" %)
	147	(((
	148	(% class="card-body" %)
	149	(((
	150	(% class="card-title" %)
	151	(((
23.25	152	===== [[Skins>>Documentation.AdminGuide.Skins]] =====
22.1	153	)))
	154
23.13	155	(% class="card-subtitle mb-2" %)
	156	(((
	157	====== Learn how to use a different skin and even how to create a complete new one. ======
	158	)))
	159	)))
	160	)))
	161	)))
	162
22.1	163	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	164	(((
23.13	165	(% class="card card2" %)
	166	(((
	167	(% class="card-body" %)
	168	(((
	169	(% class="card-title" %)
	170	(((
23.25	171	===== [[Backup/Restore>>Documentation.AdminGuide.Backup]] =====
22.1	172	)))
23.13	173
	174	(% class="card-subtitle mb-2" %)
	175	(((
	176	====== Learn how to backup and restore your wiki. ======
22.1	177	)))
23.13	178	)))
	179	)))
	180	)))
	181	)))
	182
22.1	183	(% class="hidden-xs" %)
	184	----
	185
	186	(% class="row cards" %)
	187	(((
	188	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	189	(((
23.13	190	(% class="card card2" %)
	191	(((
	192	(% class="card-body" %)
	193	(((
	194	(% class="card-title" %)
	195	(((
31.1	196	===== [[Documentation.AdminGuide.Performances.Database Administration.WebHome]] =====
22.1	197	)))
	198
23.13	199	(% class="card-subtitle mb-2" %)
	200	(((
	201	====== Administer your XWiki database. ======
	202	)))
	203	)))
	204	)))
	205	)))
	206
22.1	207	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	208	(((
23.13	209	(% class="card card2" %)
	210	(((
	211	(% class="card-body" %)
	212	(((
	213	(% class="card-title" %)
	214	(((
30.1	215	===== [[Performance Tuning>>Documentation.AdminGuide.Performances.WebHome]] =====
22.1	216	)))
	217
23.13	218	(% class="card-subtitle mb-2" %)
	219	(((
	220	====== Improve your wiki's performance. ======
	221	)))
	222	)))
	223	)))
	224	)))
	225
22.1	226	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	227	(((
23.13	228	(% class="card card2" %)
	229	(((
	230	(% class="card-body" %)
	231	(((
	232	(% class="card-title" %)
	233	(((
23.25	234	===== [[Documentation.AdminGuide.Security]] =====
22.1	235	)))
23.13	236
	237	(% class="card-subtitle mb-2" %)
	238	(((
	239	====== Tune the configuration to secure your wiki. ======
22.1	240	)))
23.13	241	)))
	242	)))
	243	)))
	244	)))
	245
	246
22.1	247	(% class="row cards" %)
	248	(((
	249
	250	)))
	251
	252	== Other Topics ==
	253
	254
27.1	255	; [[Multi Tenancy>>Documentation.AdminGuide.Virtualization.WebHome]]
22.1	256	: Learn how you can have multiple wikis running on the same XWiki instance (i.e. same JVM) for great scalability.
	257
28.1	258	; [[Access a wiki>>Documentation.AdminGuide.Virtualization.AccessWiki.WebHome]]
22.1	259	: Learn the different ways to target a wiki when you have more than one wiki in your instance.
	260
34.1	261	; [[Applications installation into wiki-farm>>Documentation.AdminGuide.Installation.ApplicationInstallationIntoWikiFarm.WebHome]]
22.1	262	: Learn the peculiarities of application installation on wiki-farm
	263
23.25	264	; [[Documentation.AdminGuide.Group Management]]
19.1	265	: Add, Edit, Delete and manage groups.
	266
33.1	267	; [[Documentation.AdminGuide.Configuration.Encoding.WebHome]]
19.1	268	: Learn how to configure XWiki for UTF-8 or any other non-default encoding.
	269
23.25	270	; [[Documentation.AdminGuide.Logging]]
19.1	271	: Configure XWiki's logging system.
	272
23.25	273	; [[Documentation.AdminGuide.Attachments]]
19.1	274	: Configure how attachments are stored, whether version history will be kept and set size limits.
	275
34.2	276	; [[Short URLs>>Documentation.AdminGuide.ShortURLs]]
19.5	277	: Learn how to configure the XWiki URL scheme to generate short URLs.
19.1	278
29.1	279	; [[Clustering>>Documentation.AdminGuide.Clustering.WebHome]]
19.1	280	: You can run multiple instances of XWiki on the same database to be able to do load balancing. Here's how to do it.
	281
23.25	282	; [[Documentation.AdminGuide.Monitoring]]
19.1	283	: Monitor a running instance using JMX
20.1	284
23.25	285	; [[AntiSpam Techniques>>Documentation.AdminGuide.AntiSpam]]
20.1	286	: Various strategies and tools to fight spam in public XWiki instances

Wiki source code of Administrator Guide

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected