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