Installation

Last modified by Clément Aubin on 2017/12/14

XWiki is a Java-based wiki and runs on a Servlet Container such as Tomcat, Jetty, JBoss, WebLogic, WebSphere, etc. It also uses a relational database to store its content. It can run on almost any database (HSQL, MySQL, etc) but XWiki and the database need to be setup correctly.

There are several ways of installing XWiki:

  • Use the Standalone distribution which already packages a Servlet Container (Jetty) and a database (HSQL), filled with default wiki pages. This is the recommended option for first time XWiki users and for users who wish to quickly try out XWiki.
  • Use the WAR distribution and configure both your container and your database to work with it.
  • Use the .deb package to install the last version of XWiki and the dependencies.
  • Use a non-official installation method.

If you're upgrading an existing XWiki install check the Upgrade instructions page.

Pick one of the trails in the outline on the right to get started.

Once you've finished the installation check the other topics in the Admin Guide for configuring and securing your wiki.

If you want to make a manual installation or need to migrate an existing XWiki installation, check the Release Notes.

Hardware and Software requirements

  • Java 1.8.0_101 or greater installed for XWiki >= 8.1 (Java 7 or greater for XWiki < 8.1, Java 6 or greater for XWiki versions < 6.0). For the moment we don't recommend running on Java 9 since we're still testing it and fixing issues. If you really insist on Java 9, make sure to use the latest released version of XWiki!.
  • A Servlet Container supporting Servlet 3.0.1 (Servlet 2.4 for XWiki versions < 7.0)
  • A Database and a JDBC 4 Driver for your database (JDBC 3 was required for XWiki versions < 7.0)
  • Enough memory, check the Memory section of the Performance Guide.
  • Check the release notes for the version you're installing to see what browsers and databases are supported for it. You can also check our general support strategy.

Installation Methods

  • Using a standalone distribution : Provides a built-in XWiki, with a portable database and a lightweight Java container. This standalone distribution is not recommended in a production environment. If you need to use it in a production basis, you may look at the other options.
  • Using .war package (usable for production): Provides a Java application package that has to be installed in a Java container (such as Tomcat). This can be used on almost any operating system.
  • Using .deb package (usable for production): Provides a .deb package that can be used on a Debian-based operating system. It can be installed with dpkg or apt; installation is thus automated.
  • Using an official XWiki Docker image: Provides an easy solution to test XWiki, with a configuration very close to a production setup.

Other Installation Methods

This section is about other, non-official ways of installing XWiki that have been contributed by the community.

Tutorials external to the xwiki.org site have not been validated for correctness by the XWiki Development Team and it's also possible that they are out of date or even not working.

Troubleshooting

You can verify some basic settings of your XWiki installation (on Tomcat, MySQL) using the Admin Tools application. Keep in mind that some of these tools only work in a Linux environment.

Running multiple instances of XWiki in the same container

If you get this error:

com.xpn.xwiki.XWikiException: Error number 3 in 0: Could not initialize main XWiki context
Wrapped Exception: Failed to get cache factory component
...
Caused by:
org.infinispan.jmx.JmxDomainConflictException: Domain already registered org.xwiki.infinispan

You need to edit WEB-INF/cache/infinispan/config.xml for each instance of XWiki.

  1. For Infinispan up till version 6, change the jmxDomain value (found under the globalJmxStatistics tag) to have a unique name, or add  allowDuplicateDomains="true" attribute for globalJmxStatistics element.
  2. For Infinispan version 7, add <jmx duplicate-domains="true"/> element in <cache-container... element.
               

Running XWiki behind proxy-server

Extension manager relies on remote repositories for searching and fetching available extensions, so if your XWiki is installed in a network accessing the internet through proxy-server, most likely extensions search will return you nothing and log files will contain connection refused exceptions.

In such cases you should configure XWiki to know your proxy-server.

XWiki uses default Java proxy configuration through Apache httpclient. See the Java Networking and Proxies documentation for more details.
The main idea is to add a set of proxy-related properties to system scope.

E.g. for Tomcat 6 it could be done in the following way: modify /<tomcat-home>/bin/catalina.sh and added proxies to the JAVA_OPTS variable definition:

JAVA_OPTS="$JAVA_OPTS -Dappserver.home=$CATALINA_HOME -Dappserver.base=$CATALINA_HOME **-Dhttp.proxyHost=proxy.mycompany.com -Dhttp.proxyPort=7777 -Dhttps.proxyHost=proxy.mycompany.com -Dhttps.proxyPort=7777** -Xmx512m -XX:MaxPermSize=196m $XWIKI_OPTS"

Unsupported major.minor version 51.0

This is because starting with version 6.0, XWiki requires Java 7 and you're using Java 6. You need to upgrade your Java version.

Installing without internet connection

XIP package

Since 9.5 a XIP package is provided for the Standard flavor.

This is actually a zip file containing the required XWiki extensions in the same format than the local extensions repository.

  • download it
  • unzip it (rename it to .zip if your zip tool does not recognize it) in the folder <permanentdirectory>/extension/repository (if you get complains about already existing files don't overwrite them)
  • restart XWiki if it was running
  • resume standard installation, this time it will find the flavor locally

Other methods

Several options:

Deprecated methods

Manually Import Wiki Pages

This is not supported anymore since 9.5

You can also skip the Distribution Wizard import the default Wiki that we are providing as a XAR file by using the Import feature. Since there's no Admin user created at this point, you'll need to log in as superadmin to be able to perform this import. 

If you're upgrading an existing wiki using the manual Import feature, be careful that the XAR import operation will replace the content of the existing pages of your wiki with the content of the XAR (New pages that you have created will not be modified). As a consequence it's critical that you perform a backup first and read the upgrade nodes bellow carefully.

On the other hand, if you use the Distribution Wizard, it'll automatically perform a merge and prompt you for action in case there's a conflict it cannot resolve automatically. Thus using the Distribution Wizard is what we recommend.

Getting an error about SSL certificate

If you get an error in the log telling you that it fail to access some some https website it usually means you have a too old version of Java 8 (older that update 101) and you should upgrade it (does not need to be upgraded to next major version of Java, just make sure you have at least Java 8 update 101).

2017-03-14 20:40:17,494 [http://dwswiki10:8080/xwiki/bin/admin/XWiki/XWikiPreferences?editor=globaladmin&section=XWiki.AddExtensions] ERROR aultExtensionRepositoryManager - Failed to search on repository [store.xwiki.com:xwiki:https://store.xwiki.com/xwiki/rest] with query [[email protected]]. Ignore and go to next repository.
org.xwiki.extension.repository.search.SearchException: Failed to search extensions based on pattern []
        at org.xwiki.extension.repository.xwiki.internal.XWikiExtensionRepository.search(XWikiExtensionRepository.java:434)
...
Caused by: java.io.IOException: Failed to request [https://store.xwiki.com/xwiki/rest/repository/search?start=0&number=20&q=]
        at org.xwiki.extension.repository.xwiki.internal.XWikiExtensionRepository.getRESTResource(XWikiExtensionRepository.java:246)
...
Caused by: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
        at sun.security.ssl.Alerts.getSSLException(Alerts.java:192)
...
Caused by: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
        at sun.security.validator.PKIXValidator.doBuild(PKIXValidator.java:387)
...
Caused by: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
        at sun.security.provider.certpath.SunCertPathBuilder.build(SunCertPathBuilder.java:145)
...

"File path too long" on Windows when unzipping

The Windows Operating System imposes a file path limit to around 260 characters. XWiki's zip file can, in some cases, reach paths as long a 182 characters, or even longer. To avoid such errors you could do one of the following:

  • Install in a folder that is as close to the root of the drive as possible and uses a small name, e.g. C:\xwiki
  • Install XWiki using the cygwin environment that overcomes this limitation
  • Starting with Windows 10, you can set or create the EnableLongPaths with a value of 1 in the in the HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem Windows Registry in order to activate support for long paths. More details and step-by-step instructions are available in various online tutorials such as this one.
Tags:
Created by Vincent Massol on 2017/09/06
   

Get Connected