WildFly 17.x

The instructions are the same as for Wildly 14.x below.

WildFly 14.x

The instructions are the same as for Wildly 10.x below.

WildFly 10.x

The instructions are the same as for JBoss AS 7.x below.

Some documentation that can be useful:


Weld Deployment Error

WildFly does automatic implicit CDI deployment when it finds some CDI beans in JARs. We need to prevent this since XWiki doesn't use CDI and there can be some third-party deps we use that have some CDI annotations.

Note that we fixed this by providing a META-INF/jboss-all.xml file telling WildFly to not do CDI bean scanning in XWiki 8.3M2+. However we found a problem with it and removed it in XWiki 10.8RC1+. In the end, it was found that this file was needed after all and put back in XWiki 10.11.9/11.3.2/11.6RC1+...

If you're using a version of XWiki that doesn't provide this jboss-all.xml then create one in the META-INF directory inside the XWiki WAR, with the following content:

<?xml version="1.0" encoding="UTF-8"?>

 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.

<!-- Required to tell WildFly to not do CDI bean parsing and try to do implicit deployment of them since XWiki doesn't
     use CDI -->

<jboss xmlns="urn:jboss:1.0">
 <weld xmlns="urn:jboss:weld:1.0" require-bean-descriptor="true"/>

JBoss AS 7.x

Example using Standalone Deployment

  • Copy the xwiki expanded WAR directory in JBOSSHOME/standalone/deployments/xwiki.war
  • Do a touch JBOSSHOME/standalone/deployments/xwiki.war.dodeploy
  • Start JBoss standalone: run ./standalone.sh from JBOSSHOME/bin/


"More than the maximum number of request parameters" error

If you get the following error in the logs when trying to import a large XAR:

Servlet.service() for servlet action threw exception: java.lang.IllegalStateException: More than the maximum number of request parameters (GET plus POST) for a single request ([512]) were detected. Any parameters beyond this limit have been ignored. To change this limit, set the maxParameterCount attribute on the Connector.

You'll need to configure Tomcat in JBoss to support more than 512 form fields.

JBoss AS 4.0.x

  • Download and install the "JBoss Application Server". It's usually as simple as unzipping it in a directory. Let's call this directory $JBOSS_HOME
  • (optional) By default JBoss runs on port 8080. If you want to modify the port on which JBoss is running, edit $JBOSS_HOME/server/<mode>/deploy/jbossweb-tomcat55.sar/server.xml. Search for 8080 and replace it with the port value you wish to use. Similarly change the port in $JBOSS_HOME/server/<mode>/deploy/http-invoker.sar/META-INF/jboss-service.xml to the value you like
  • Copy and expand the XWiki WAR into a directory named xwiki.war/ (note that unlike most servlet containers JBoss wants the directory name to end with .war) in $JBOSS_HOME/server/<server configuration>/deploy where server configuration is the JBoss configuration you're using
  • Edit $JBOSS_HOME/server/<mode>/deploy/jbossweb-tomcat55.sar/server.xml to set UTF-8 encoding:
    <Connector port="8080" ... URIEncoding="UTF-8"/>
    <Connector port="8009" ... URIEncoding="UTF-8"/>

Classloading Isolation

The default JBoss behavior is that classes inside of the WEB-INF/classes and WEB-INF/lib directories of the WAR file are incorporated into the default shared class loader repository. This allows classes and resources to be shared between web applications. However this means that JARs provided by XWiki in WEB-INF/lib will get mixed with JARs provided by JBoss and if both application provide the same JAR but in a different version, class incompatibilities will occur. 

To solve this please read up on JBoss ClassLoading Configuration in order to configure JBoss not to use the unified class loader (set UseJBossWebLoader to false in META-INF/jboss-service.xml).

Alternatively you may try to remove the clashing JARs from XWiki's WEB-INF/lib hoping that the version provided by JBoss is compatible with XWiki's needs.

Log4j Error

It was reported that with XWiki 1.6 and JBoss 4.0.4, using these settings would generate an error with hibernate. Everything seems to work fine without these settings including classloading of log4j.

  • Edit $JBOSS_HOME/server/<server configuration>/jbossweb-tomcat55.sar/META-INF/jboss-service.xml file and replace:
    <attribute name="Java2ClassLoadingCompliance">false</attribute>
    <attribute name="UseJBossWebLoader">false</attribute>
    <attribute name="Java2ClassLoadingCompliance">true</attribute>
    <attribute name="UseJBossWebLoader">true</attribute>
    This is to avoid class loading issues for the Log4J library.

Using a JBoss DataSource

JBoss links about this topic:

Tutorial for JBoss AS 7.1

  • Create a JBoss Module for your database driver. For example for HSQLDB, create the directory [ASROOT]/modules/org/hsqldb/main and put the HSQLDB Driver JAR (e.g. hsqldb-2.2.9.jar) in it and also create a module.xml in it and write the following code inside:
    <?xml version="1.0" encoding="UTF-8"?>
    <module xmlns="urn:jboss:module:1.0" name="org.hsqldb">
       <resource-root path="hsqldb-2.2.9.jar"/>
       <module name="javax.api"/>
  • Create a data source file named -ds.xml (e.g. hsqldb-ds.xml). If you're using a standalone deployment, put it in [ASROOT]/standalone/deployments/ (you can also put it in your WEB-INF/ dir). Example of content:
    <?xml version="1.0" encoding="UTF-8"?>
    <datasources xmlns="http://www.jboss.org/ironjacamar/schema">
     <datasource jndi-name="java:jboss/datasources/XWikiDS" pool-name="XWikiDS" enabled="true" use-java-context="true">
       <connection-url>jdbc:hsqldb:file:[path to your hsqldb db file, e.g. /tmp/xwiki-data/database/xwiki_db];shutdown=true</connection-url>

Old Tutorial

  • Uncomment the resource-ref section in XWiki's web.xml file. You should have:
     <description>DB Connection</description>
  • Create the following jboss-web.xml file in the deployed XWiki's WEB-INF/ directory:
    <?xml version="1.0" encoding="ISO-8859-1"?>
    <!DOCTYPE jboss-web PUBLIC  "-//JBoss//DTD Web Application 2.3V2//EN" "http://www.jboss.org/j2ee/dtd/jboss-web_3_2.dtd">
  • Modify XWiki's WEB-INF/hibernate.cfg.xml file to tell Hibernate to use the defined DataSource rather than a direct JDBC connection:
    <property name="connection.datasource">java:jboss/datasources/XWikiDS</property>

Issues related to JBoss

TypeKeySummaryStatusCreated Date
BugXWIKI-7989Fail to import Default XE XAR in JBoss AS7Closed29-Jun-2012
BugXWIKI-7987Failed to deploy on JBoss AS7 with SLF4J class cast exceptionClosed29-Jun-2012
BugXWIKI-7986Failed to deploy on JBoss AS7 with Taglib errorsClosed27-Jun-2012
BugXWIKI-7984Jboss AS 7 does not like jythonClosed27-Jun-2012
BugXWIKI-5946Extension manager fails on JBoss AS 5Closed02-Feb-2011
BugXWIKI-3093Container managed Datasource not working (JBOSS 4.2.2, Xwiki 1.6.2)Closed11-Jan-2009
ImprovementXWIKI-1027Support deployment on Jboss 4.xClosed26-Mar-2007
ImprovementXINFRA-13Encoding configuration for JBoss usersClosed10-Apr-2012
BugXCOMMONS-208Failed to deploy on JBoss AS7 with Reflections VFS errorsClosed29-Jun-2012
Created by Vincent Massol on 2017/09/06

Get Connected