Contains administration tools for managing a running XWiki instance

Description

This XAR contains many administration tools for XWiki Enterprise or XWiki Enterprise Manager. This tool replaces the ImportExport tool, the CheckConfig tool as well as some snippets.

Configuration Checks

The CheckConfig page checks:

• Memory settings
• Database pool settings
• Cache settings
• Encoding settings

The CheckIndexes page checks:

• indexes on the main wiki and on child wikis of an XEM instance
• allows to create the indexes directly from the wiki both on the main wiki and subwikis

The CheckDBEncoding page checks:

• the default encoding and collection settings of the MySQL engine
• the default encoding and collection of the 'xwiki' database 
• the encoding and collection of the xwikidoc table
• the encoding and collection of all the databases and xwikidoc tables of a XEM instance

The CheckRights page checks:

• every space, page that has rights against the standard user and one chosen user

The CheckProgrammingRights checks:

• every page that should have programming rights in the default wiki

The CheckPreferencesPages checks:

• preferences pages that should have been upgraded to Syntax 2.0

TODO:

• add support for xwiki.db.prefix
• add support for xwiki.db

Other Admin Tools

• Requests Status
• Flush Cache
• Activity Report
• Wiki Diff
• Export Tools
• Run Query
• Used Space

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:

1. Log in the wiki with a user having Administration rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions
5. 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

v3.0.1

• Fixed programming rights check page error
• Stop saving known PR pages that does not exist

v3.0

Many fixes in this new version. This version has been tested with XWiki 3.5.x and 4.0 but should still be generally compatible with older version.

• New Modules
• Added SanityCheck to check database consistency
• Updated Tools page to list new sanityCheck page
• Addition of the ShrinkRecycleBins new page to easily suppress deleted pages and attachments
• New Home Page
  • Addin a home page that lists all admin pages
  • Updated WebHome to include Tools page
• CheckConfig:
  • Updated CheckXWikiConfig to support Infinispan Cache (XWiki 3.5+) 
  • Human readable memory sizes
  • Protect against NPE when checking cache configurations
• RunQuery
  • Upgrade RunQuery to xwiki/2.0 syntax
  • Updated RunQuery to fix escaping wiki syntax
  • Close the transaction at the end of the query execution
• Check Programming Rights
  • Modified CheckProgrammingRights to also check the documents with RequiredRightsClass objects with required right edit or programming.

v2.0.2

• Added a more relaxed verification for windows OS for getting environment variables, which seems to be needed on Windows server 2008

v2.0.1

FIXED : selective export for non standard URLs (path-based XEM, webapp name other than xwiki, etc.)

Import in your wiki and visit Admin.Tools.

This version has been tested with XEM 2.7. It might work with 2.x+.

v2.0

Import in your wiki and visit Admin.Tools.

This version has been tested with XEM 2.7. It might work with 2.x+.