Admin Tools Application

Last modified by Antoine Mottier on 2024/11/04 00:09

Contains administration tools for managing a running XWiki instance

Type	XAR
Category
Developed by	Ludovic Dubost, Jerome Velociter, Sergiu Dumitriu, Anca Paula Luca, Maxime Sinclair, Andreas Jonsson, Thomas Mortagne, Oana Tabaranu, Guillaume Fenollar
Active Installs	233
Rating	5.0 1 2 3 4 5 16 Votes
License	GNU Lesser General Public License 2.1

Compatibility

Version 2.0: Tested on XE 2.7
Versions 2.0.1 and 2.0.2: Tested on XE 3.1
Version 3.0: Tested on XWiki 3.5.1 and 4.0 but should still be generally compatible with older versions
Version 4.0: Tested on XWiki 4.5.4 and 5.1

Installable with the Extension Manager

Download v4.5.5SourcesIssues

Description

This XAR contains many administration tools for XWiki Enterprise or XWiki Enterprise Manager.

Configuration Checks : Shows and check XWiki configuration, with some recommendations when parameters are not optimized for best performances.
Export/Import Tools : Several tools to import and export spaces and pages. It includes Large Import and Large Export applications, to be used when the database is to big to be exported from the wiki administration.
Flush Cache : Flush XWiki cache.
Wiki Diff : Make a wiki diff to compare current wiki with the standard .xar package.
Used Space : Shows used space of recycle bin, history, and attachments related tables, for all subwikis.
Shrink Recycle Bins : Permit to reduce space used, shrinking the recycle bins for pages and attachments.
Show Logs : Show n number of logs lines.
Show History : Show 20 largest history pages.
Show Spammed pages : List every page with more than 50 comments.
Sanity Check : Run a sanity check upon the database.
Show Rights : List every specific rights set in wiki / spaces / pages.
Database To Filesystem porter : Used to migrate every attachment from the DB to the filesystem (xwiki permanent directory), when Filesystem Storage feature is used.
Run Query : Run a SQL query in the current DB.

Requesting many lines with the Show Logs utility can cause performance issues (see ADMINTOOL-69).

Details and Screenshots

Configuration Checks:
Used Space:
Show Rights:
Run Query:
The default URL uses the main wiki:
jdbc:mysql://<server>/xwiki?useServerPrepStmts=false&useUnicode=true&characterEncoding=UTF-8
To run queries on a different wiki (database) you need to update the URL with the proper name of the wiki (each wiki is stored as a different database):
jdbc:mysql://<server>/<wikiname>?useServerPrepStmts=false&useUnicode=true&characterEncoding=UTF-8
Proper credentials are needed to run the queries, you can also use the settings from "hibernate.cfg.xml":
<property name="connection.username">user</property>
<property name="connection.password">password</property>

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

Log in the wiki with a user having Administration rights
Go to the Administration page and select the Import category
Follow the on-screen instructions to upload the downloaded XAR
Click on the uploaded XAR and follow the instructions
You'll also need to install all dependent Extensions that are not already installed in your wiki

After importing the XAR visit the page Admin.Tools

Release Notes

v4.5.5

Issues fixed in this release:

This release also:

Fix "Database to Filesystem porter" code in order to prevent error With XWiki version >= 12.0.
Detect correctly MariaDB instead of previously reporting the RDBMS to be MySQL.
Fix compatibility with Groovy 4 used in XWiki version >= 16.0.0.
Removed some SanityCheck SQL queries as they are either deprecated (test XWD_PARENT in xwikidoc table) or depends on specific XWiki configuration (tests on xwikiattachment_archive and xwikiattachment_content content even if xwiki.store.attachment.hint=file is used)
Add a new "Comment Manager" tool.
Fix some page formatting.