CheckXWikiConfig


XWiki Configuration Check

This script intends to show most important parameters for XWiki hosting. You can go directly to recommendations

Installation Path

  • XWiki configuration path: /etc/xwiki/xwiki.cfg
  • Tomcat configuration path: /var/lib/tomcat9/conf/server.xml

Memory Configuration

This lists the memory settings of the Java VM and the current memory usage. An XWiki instance should be installed with at least 1Gb. A large one with at least  2GB to 4GB, especially if the cache settings are boosted. If after *flushing the cache*, the current free memory is low and the current total close to the maximum the instance might be running out of memory.

  • Max Memory: 4 GB
  • Current Total: 1.9 GB
  • Current Free: 977.7 MB

Cache configuration

This lists the main cache settings. An XWiki instance is set by default to 500 for the main cache which is fine for a normal instance. A large one with at least 1000  to 3000. Java Memory needs to be increased to support a larger cache. This setting can be changed in xwiki.cfg with the property xwiki.store.cache.capacity

  • Store Page Cache in Use : -1/500

Database configuration

This lists the database settings of the Java VM and the current pool usage. An XWiki instance is set by default to 2 connections in the pool, which is ok for a very small instance. A large one with at least 10 or 20. If there is no activity on the server, the active setting should be zero.

  • Max Active (number of possible connections to the DB): 50
  • Max Idle (number of possible idle connections to the DB): 5
  • Active (current active connections to the DB): 1
  • Idle (current idle connections to the DB): 4

Authenticator Configuration

  • Authenticator class configured in xwiki.cfg: org.xwiki.contrib.ldap.XWikiLDAPAuthServiceImpl

Encoding Configuration

This lists ALL the encoding configuration of tomcat, xwiki, java. All should return UTF-8 except mail.mime.charset which can also return null (the file.encoding config will then be used)

System environment

  • LANG :en_US.UTF-8
  • PWD :/var/lib/tomcat9

Java command line

  • file.encoding: utf8
  • mail.mime.charset: null

Tomcat configuration

Prior to Tomcat8 it was necessary to set the connection encoding of protocols to UTF-8. Since Tomcat8+ this is not necessary anymore.

  • Procotol HTTP/1.1 has encoding null

XWiki Configuration

  • XWiki encoding used on server: UTF-8
  • XWiki encoding from config file: UTF-8

Recommendations

Here will be shown our recommendations to increase wiki's performance and stability, if any :

  • WarningYour cache configuration is too low for a production usage. Your cache is set to 500 documents, it should be 1000 or more.

EU programme:  HORIZON-CL4-2021-HUMAN-01  

flagEU.svg

This project has received funding from the European Union’s Horizon Europe research and innovation programme under the grant agreement 101069364 and it is framed under Next Generation Internet Initiative.

Follow us on social media

linkedin.svgNGISearch_Logo_Icon-circle-N-rgb.svgmastodon-circle.svg

XWiki Enterprise 16.10.17 - Documentation