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: 2.9 GB
Current Free: 1.9 GB

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)