Skip to Content

Wiki source code of Installation

Last modified by Vincent Massol on 2024/10/28
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 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 (MySQL, PostgreSQL, etc) but XWiki and the database need to be setup correctly.
6
7 If you're upgrading an existing XWiki install check the [[Upgrade instructions page>>Documentation.AdminGuide.Upgrade]].
8
9 Pick one of the [[installation methods>>#HInstallationMethods]] to begin installing XWiki.
10
11 Once you've finished the installation check the other topics in the [[Admin Guide>>Documentation.AdminGuide.WebHome]] for configuring and [[securing>>Documentation.AdminGuide.Security]] your wiki.
12
13 {{id name="Prerequisites"/}}
14
15 = Hardware and Software requirements =
16
17 * A [[supported Java version>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]]. Note that a JRE is enough and you don't need a JDK.
18 * A Servlet Container supporting Servlet 3.1 (Servlet 3.0.1 for XWiki version < 12). Check the [[Servlet Containers officially supported by XWiki devs>>dev:Community.ServletContainerSupportStrategy.WebHome]].
19 * A Database and a JDBC 4.2 Driver for your database (JDBC 4 was required for XWiki versions < 11.5). Check the [[databases offically supported by XWiki devs>>dev:Community.DatabaseSupportStrategy]].
20 * A supported browser to access XWiki. Check the [[browsers offically supported by XWiki devs>>dev:Community.BrowserSupportStrategy]].
21 * Enough memory, check the [[Memory section>>Documentation.AdminGuide.Performances.WebHome#HMemory]] of the [[Performance Guide>>Documentation.AdminGuide.Performances.WebHome]].
22 * Enough [[CPU and RAM>>Documentation.AdminGuide.Performances.WebHome#HSizing]]
23 * Check the [[release notes>>xwiki:ReleaseNotes.WebHome]] for the version you're installing to see what browsers and databases have been tested for it, and to see specific requirements/installation steps. You can also check our [[general support strategy>>dev:Community.SupportStrategy]].
24 * If you're running XWiki on a server without a display, pass the following Java System Property to the JVM running your Servlet Container: ##-Djava.awt.headless=true##.
25
26 = Installation Methods =
27
28 For testing XWiki, we highly recommend one of the following installation method:
29
30 * [[Using XWiki in the cloud>>Hosted.WebHome]]: This is by far the simplest to try XWiki since you don't need to install anything.
31 * [[Using a standalone distribution >>Documentation.AdminGuide.InstallationStandalone]]: Provides a built-in XWiki, with a portable database (HSQLDB) and a lightweight Java container (Jetty). This standalone distribution is not recommended in a production environment (check the [[DB limitations>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationHSQL.WebHome]]). If you need to use it in a production basis, you may look at the other options.
32 * [[Using an official XWiki Docker image>>https://hub.docker.com/_/xwiki/]]: Provides an easy solution to test XWiki, with a configuration very close to a production setup.
33
34 For production installations, we recommend the following installation method:
35
36 * [[Using .deb package (usable for production)>>Documentation.AdminGuide.InstallationViaAPT]]: 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.
37 * [[Using an official XWiki Docker image>>https://hub.docker.com/_/xwiki/]]: You can also use this method in production if you're used to putting Docker images in production.
38
39 Last, you could manually deploy XWiki as a WAR into the Servlet Container of your choice and on the Database of your choice, if the previous methods were not good enough for your needs. Beware that this requires some technical knowledge about Servlet Container and Databases:
40
41 * [[Using .war package (usable for production)>>Documentation.AdminGuide.InstallationWAR]]: 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.
42
43 {{warning}}
44 Whatever the installation method, you should make sure to [[create the database indexes manually for indexes that are not created automatically>>Documentation.AdminGuide.Performances.Database Administration.WebHome]].
45 {{/warning}}
46
47 = Other Installation Methods =
48
49 This section is about other, non-official ways of installing XWiki that have been contributed by the community.
50
51 {{warning}}
52 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.
53 {{/warning}}
54
55 * [[Install XWiki in Kubernetes>>https://extensions.xwiki.org/xwiki/bin/view/Extension/XWikiHelm/#HRequirements]]
56 * [[How to Install XWiki on Your Synology NAS>>https://mariushosting.com/how-to-install-xwiki-on-your-synology-nas/]]
57 * [[How to install XWiki on Debian 9>>https://linuxhostsupport.com/blog/how-to-install-xwiki-on-debian-9/]]
58 * [[Ansible playbook for installing XWiki>>https://github.com/rastandy/xwiki-ansible-playbook]]
59 * [[XWiki On OpenShift (Platform-as-a-Service)>>https://github.com/rkmallik/xwiki-example]]
60 * [[XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL)>>http://www.howtoforge.de/howto/xwiki-on-debian-4-etch-tomcat-mysql]] (German)
61 * [[XWiki On Ubuntu (24.04) - Jetty - PostgreSQL (English, video)>>https://youtu.be/alVbEpbr36o]]
62 * [[XWiki On Windows - GlassFish - Oracle>>http://etvc.myxwiki.org/xwiki/bin/view/UNA/XWikiInstalation]] (Russian)
63 * [[Install XWiki using Docker compose>>https://blog.zwindler.fr/2016/09/15/installer-xwiki-8-2-1-avec-docker-compose-en-2-lignes-de-commandes/]] (French)
64 * [[XWiki in Windows - PostgreSQL - Tomcat 9 - Waffle>>https://www.youtube.com/watch?v=c2xUsnuDsBE]] (English, video)
65 * [[XWiki 10.9 with LDAP/SSO/MSSQL on Windows>>http://www.ohjeah.net/2018/11/09/xwiki-10-9-with-ldapssomssql-on-windows/]]
66 * [[XWiki Installation on AWS>>.XWiki Installation on AWS.WebHome]]
67 ** [[Deployment using CDK code>>.XWiki Installation on AWS.Deployment Using CDK Code.WebHome]]
68 ** [[Deployment Using Cloudformation Template>>.XWiki Installation on AWS.Deployment Using Cloudformation Template.WebHome]]
69
70 = Accessing your wiki =
71
72 Once you've installed XWiki using one of the methods defined above, you can access it by pointing your web browser to {{code language="none"}}http://localhost:8080/xwiki{{/code}}.
73
74 = HTTP Proxy =
75
76 You now have a working XWiki instance but it's often a good idea to access it through an HTTP proxy especially when you plan to access it through the standard HTTP/HTTPS port instead of 8080.
77
78 * [[Apache HTTPD>>Documentation.AdminGuide.Installation.ApacheHTTPD]]
79 * [[NginX>>Documentation.AdminGuide.Installation.NginX]]
80
81 = Troubleshooting =
82
83 You can verify some basic settings of your XWiki installation (on Tomcat, MySQL) using the [[Admin Tools application>>extensions:Extension.Admin Tools Application]]. Keep in mind that some of these tools only work in a Linux environment.
84
85 == What to do with an empty XWiki? ==
86
87 == Running multiple instances of XWiki in the same container ==
88
89 If you get this error:
90
91 {{code}}
92 com.xpn.xwiki.XWikiException: Error number 3 in 0: Could not initialize main XWiki context
93 Wrapped Exception: Failed to get cache factory component
94 ...
95 Caused by:
96 org.infinispan.jmx.JmxDomainConflictException: Domain already registered org.xwiki.infinispan
97 {{/code}}
98
99 You need to edit ##WEB-INF/cache/infinispan/config.xml## for each instance of XWiki.
100
101 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.
102 1. For Infinispan version 7, add ##<jmx duplicate-domains="true"/>## element in ##<cache-container...## element.
103
104
105 == Running XWiki behind a proxy server ==
106
107 The extension manager relies on remote repositories for finding and fetching available extensions. If your XWiki is installed in a network which requires accessing the internet through a proxy server, most likely searching for extensions will fail and log files will contain ##connection refused## exceptions.
108
109 In such cases, you can configure XWiki to use the proxy server.
110
111 XWiki uses default Java proxy configuration through Apache httpclient. See the [[Java Networking and Proxies documentation>>http://docs.oracle.com/javase/6/docs/technotes/guides/net/proxies.html]] for more details.
112 The main idea is to add a set of proxy-related properties to the system scope.
113
114 For an installation using 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:
115
116 {{code}}
117 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"
118 {{/code}}
119
120 For an installation of the HSQLDB demo package you could do it by adding something like this to ##/xwiki-platform-distribution-flavor-jetty-hsqldb-x.y/start_xwiki.sh##:
121
122 {{code}}
123 XWIKI_OPTS="$XWIKI_OPTS -Dhttp.proxyHost=proxy.mycompany.com -Dhttp.proxyPort=7777 -Dhttps.proxyHost=proxy.mycompany.com -Dhttps.proxyPort=7777"
124 {{/code}}
125
126 Note: If your proxy server only allows partial access to the internet you need to make sure that the sites ##store.xwiki.com##, ##extensions.xwiki.org## and ##nexus.xwiki.org## (note that one is .##com## and the others are ##.org##) can be accessed.
127
128 If your proxy server require authentication you can use ##-Dhttps.proxyUser## and ##-Dhttps.proxyPassword## (and the http alteratives).
129
130 === Debugging proxy configuration issues ===
131
132 If you are having trouble with debugging whether or not the proxy configuration you've just made is properly read by XWiki, you could drop the following groovy script in a new page on your XWiki instance and look for the values of the (proxy) properties you're trying to change:
133
134 {{code language="groovy"}}
135 {{groovy}}
136 println "== Environment Variables =="
137 System.getenv().each { name, value -> println "Name: {{{$name}}} = Value {{{$value}}}" }
138 println ""
139 println "== Java System Properties =="
140 System.getProperties().each { name, value -> println "Name: {{{$name}}} = Value {{{$value}}}" }
141 {{/groovy}}
142 {{/code}}
143
144 Additionally, you could also include this test content that actually tests if your XWiki instance is able to access the Internet (using the "httpbin" service; you can use anything else, including google.com), for both HTTP and HTTPs:
145
146 {{code language="velocity"}}
147 == Test HTTP Access ==
148 Your XWiki server's IP is:
149 {{velocity}}
150 $xwiki.getURLContent("http://httpbin.org/ip")
151 {{/velocity}}
152
153 == Test HTTPS Access ==
154 Your XWiki server's IP is:
155 {{velocity}}
156 $xwiki.getURLContent("https://httpbin.org/ip")
157 {{/velocity}}
158 {{/code}}
159
160 == Unsupported major.minor version 51.0 ==
161
162 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.
163
164 {{include reference="Documentation.AdminGuide.Installation.InstallationConcludingSteps.WebHome" section="HInstallingwithoutinternetconnection"/}}
165
166 == Getting an error about SSL certificate ==
167
168 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).
169
170 {{code language="none"}}
171 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 [org.xwiki.extension.repository.search.ExtensionQuery@78b5e254]. Ignore and go to next repository.
172 org.xwiki.extension.repository.search.SearchException: Failed to search extensions based on pattern []
173 at org.xwiki.extension.repository.xwiki.internal.XWikiExtensionRepository.search(XWikiExtensionRepository.java:434)
174 ...
175 Caused by: java.io.IOException: Failed to request [https://store.xwiki.com/xwiki/rest/repository/search?start=0&number=20&q=]
176 at org.xwiki.extension.repository.xwiki.internal.XWikiExtensionRepository.getRESTResource(XWikiExtensionRepository.java:246)
177 ...
178 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
179 at sun.security.ssl.Alerts.getSSLException(Alerts.java:192)
180 ...
181 Caused by: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
182 at sun.security.validator.PKIXValidator.doBuild(PKIXValidator.java:387)
183 ...
184 Caused by: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
185 at sun.security.provider.certpath.SunCertPathBuilder.build(SunCertPathBuilder.java:145)
186 ...
187 {{/code}}
188
189 == "File path too long" on Windows when unzipping ==
190
191 The Windows Operating System imposes a [[file path limit to around 260 characters>>https://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx#maxpath]]. 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:
192
193 * 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##
194 * Install XWiki using the [[cygwin>>https://www.cygwin.com/]] environment that overcomes this limitation
195 * 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>>https://www.howtogeek.com/266621/how-to-make-windows-10-accept-file-paths-over-260-characters/]].
196 * As Windows Unarchiver cannot unzip files with long paths, [[7-Zip>>https://www.7-zip.org/]]can be used instead.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected