Admin Tools Application (Pro)
Contains administration tools for managing a running XWiki instance
| Category | Application |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Minimal XWiki version supported | XWiki 14.10 |
| Sources | Issues |
The Admin Tools Pro application is as a valuable resource that allows the user to access a comprehensive overview of the XWiki instance. Use it to view info about your XWiki installation, easily check configurations, perform instance health checks and access log history, among other helpful features.
The Home Page of the application can be accessed using the applications panel, by clicking Admin Tools, or find the Admin Tools application in the tree overview.
Usage
On the main page, you will be able to perform the following actions:
- View info about the XWiki configurations.
- View the last lines of log.
- Access XWiki configurations and properties files.
- Select from a list of essential files and download them as an archive.
- Get an overview of the pages that might be spammed.
- Check the number of deleted pages and attachments for all wikis in instance and access the corresponding recycle bins.
- View the usage of all wikis in instance.
- Run a health check on the instance to make sure that the configurations and memory allocations are ok. Access the help links page in case of a warning or error to find instructions of how to fix them or properly configure your instance.
- Flush the cache of the instance.
External Resources
Topics
Home Page
The application's home page features access to the dashboard, which is organized into sections.
Backend section
In this section, the user can access information about the backend, including details such as the operating system, server, database, java and XWiki version.
He can also access a modal to view the last lines of log, with a maximum of extracted lines of 50000.
Files section
A user can use this section to view the XWiki configuration and properties files and the last lines of log. These files are also downloadable via a modal in which you can choose which files to download.
- For the log files, it will return all logs, not just the catalina files.
- For the XWiki properties and configuration files, make sure to exclude the lines that you don't want to be downloaded in Administration page.
Instance usage section
You can use this section to see stats related to the usage of the XWiki instance. Admins have access 3 different modals for monitoring the instance:
- Usage modal
- Spam modal
- The user can configure the number of comments for a page to be considered spammed in Administration page.
In this image, minimum number for spam has been set to 2 for demonstrative purpose.
- The user can configure the number of comments for a page to be considered spammed in Administration page.
- Recycle bins modal
All modals tables are also accessible in dedicated pages.
Health check section
In this section, you can run a health check on the instance to make sure it is correctly configured and that there are no memory issues. A user can access a help page where links to instructions for configuration and installation are available. The option to flush the cache is also available.
UI Administration page
In the XWiki Administration, there is an entry that allows you to configure the application:
- You can manually add the server location if the application does not automatically find it (currently supported server is Tomcat)
- You can add the lines that you want to be excluded from the xwiki.cfg and xwiki.properties files. Each line has to be separated with a comma (","), with no empty spaces between.
- You can manually set the minimum spam limit for a page.
Requirements
User have administrator rights.
Tomcat servlet is mandatory.
Installation Steps
This paid extensions requires XWiki 14.10 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).
Navigate to the Extension Manager
In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.
Install the Extension
Search for the extension you wish to install and use the Install button to install it.
Get a License
Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.
Install the License
If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.
However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.
Use the Extension
Start using the Extension! Refer to the extension's documentation to know how to use it.
Installing Paid Apps on Subwikis
If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:
Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.
Options
The price is per year and varies depending on the support level and the number of users.
| Support / Users | 10 | 25 | 50 | 100 | 250 | 500 | 1000 | 2500 | 5000 | 10000 | 20000 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Silver |
Benefits
What do you get when you purchase an XWiki extension?
1 year license
By purchasing an XWiki extension license, you'll benefit from it during one year.
Free updates
You benefit from all the extension updates during one year. You are always up to date.
Support included
If you are facing an issue, you can reach the XWiki support. Our team is always available to help.
How to Buy
To buy, install this extension from inside your XWiki instance and follow the instructions.
Release notes
v1.0.1
Improvements:
- #95: Implement a section showing a list of empty pages
- [MISC] Add XIP module
v1.0
Initial version.
Extension details
License
- GNU Lesser General Public License 2.1
Sources
Issues
Type
- xar
Developed by
Compatibility
- Requires XWiki 14.10 or above.
Dependencies
- com.xwiki.admintools:application-admintools-default 1.0.1
- com.xwiki.licensing:application-licensing-licensor-api 1.25
- org.xwiki.platform:xwiki-platform-livetable-ui 14.10
- org.xwiki.platform:xwiki-platform-sheet-ui 14.10
- org.xwiki.platform:xwiki-platform-uiextension-ui 14.10
- org.xwiki.platform:xwiki-platform-display-macro 14.10