wrenchContains administration tools for managing a running XWiki instance
TypeXAR
Developed by

Ludovic Dubost, Jerome Velociter, Sergiu Dumitriu, Anca Paula Luca, Maxime Sinclair, Andreas Jonsson, Thomas Mortagne, Oana Tabaranu, Guillaume Fenollar

Active Installs449
Rating
Rate!
15 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

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:

    configurationCheck.jpg

  • Used Space:

    usedSpace.jpg

  • Show Rights:

    showRights.jpg

  • Run Query:

    Query.png

    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>

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
4.1.8XWiki Enterprise 9.1.2

This blocker was discovered while testing https://jira.xwiki.org/browse/ADMINTOOL-47

4.1.8XWiki 9.8.1

Known blocker: https://jira.xwiki.org/browse/ADMINTOOL-47

4.1.8XWiki 9.9

Known blocker: https://jira.xwiki.org/browse/ADMINTOOL-47

4.1.8XWiki 10.8.3

Known blocker: https://jira.xwiki.org/browse/ADMINTOOL-47

4.1.8XWiki 10.11.1

Known blocker: https://jira.xwiki.org/browse/ADMINTOOL-47

4.2XWiki 10.11.2
4.2XWiki 11.1, 11.3, 11.5, 11.3.4
4.2XWiki 11.7, 11.9, 11.10, 11.10.2, 11.10.3, 12.1

Critical issue: https://jira.xwiki.org/browse/ADMINTOOL-57
Other issues: https://jira.xwiki.org/browse/ADMINTOOL-59; https://jira.xwiki.org/browse/ADMINTOOL-60

4.3XWiki 11.10

Tested on 11.10 but it should work on more versions

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

v4.3.2

v4.3.1

v4.3

Various fixed to make it work with XWiki 11.10
Added JMXCache to allow to flush all cache and view cache information

v4.2

v4.1.8

v4.1.7

v4.1.6

v4.1.5

v4.1.4

v4.1.3

v4.1.2

v4.1.1

v4.1

v4.0

  • All scripts have been rewriten using xwiki 2.1 (mostly) or 2.0 syntax.
  • SQLTools developed by Guillaume Delhumeau has been implemented to standardize SQL queries inside Admin Tools. With it, we now can Run Query, Show Large History, Show Spammed Pages... We plan to include PostgreSQL scripts very soon.
  • Used Space page has been rewritten completely. It summarizes now disk space used by all subwikis of the farm, and show attachments related database if filesystem storage mode is not used.
  • Configuration Check page has been rewritten, with some recommendations at the bottom depending on the configuration. At the moment, we put recommendations about memory, cache, encoding and cookies encryption keys.
  • User Rights Check has been replaced by Show Rights, which simply shows every right set on wiki / spaces / pages. It may be useful when we put temporary rights to pages (which can lead to security leaks)
  • Show Logs script have been included with a UI which permits to choose number of loglines to output, directly in the wiki page.
  • Export Tools now have Large Export/Import scripts
  • DatabaseToFilesystem porter script has been added (it seems not compatible with 5.x at the moment though).
  • Requests Status page has been dropped

TODO: Finish indexes integration in CheckSQLIndexes.

v3.0.2

v3.0.1

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

v2.0.2

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

Dependencies

Dependencies for this extension (org.xwiki.contrib:xwiki-application-admintools 4.3.2):

  • org.xwiki.rendering:xwiki-rendering-macro-message 4.5
Created by Ludovic Dubost on 2011/01/31 17:06
    

Get Connected