Wiki source code of Installation
Last modified by Eleni Cojocariu on 2026/08/13 16:22
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | {{warning}} | ||
| 6 | WIP: topic is being refactored in new location, top level page of new hierarchy: [[Installation>>documentation.xs.admin.installation.WebHome]]. | ||
| 7 | {{/warning}} | ||
| 8 | |||
| 9 | {{id name="Prerequisites"/}} | ||
| 10 | |||
| 11 | = Hardware and Software requirements = | ||
| 12 | |||
| 13 | See [[Prerequisites>>documentation.xs.admin.installation.prerequisites.WebHome]]. | ||
| 14 | |||
| 15 | = Installation Methods = | ||
| 16 | |||
| 17 | {{warning}} | ||
| 18 | WIP: topic is being refactored in new location, [[Installation methods>>documentation.xs.admin.installation.methods.WebHome]]. | ||
| 19 | {{/warning}} | ||
| 20 | |||
| 21 | For testing XWiki, we highly recommend one of the following installation method: | ||
| 22 | |||
| 23 | * [[Using XWiki in the cloud>>Hosted.WebHome]]: This is by far the simplest to try XWiki since you don't need to install anything. | ||
| 24 | * [[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.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-hsqldb.hsqldb-limitations.WebHome]]). If you need to use it in a production basis, you may look at the other options. | ||
| 25 | * [[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. | ||
| 26 | |||
| 27 | For production installations, we recommend the following installation method: | ||
| 28 | |||
| 29 | * [[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. | ||
| 30 | * [[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. | ||
| 31 | |||
| 32 | 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: | ||
| 33 | |||
| 34 | * [[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. | ||
| 35 | |||
| 36 | 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]]. | ||
| 37 | |||
| 38 | = Other Installation Methods = | ||
| 39 | |||
| 40 | See [[Unofficial installation methods>>documentation.xs.admin.installation.methods.unofficial-methods.WebHome]]. | ||
| 41 | |||
| 42 | = Accessing your wiki = | ||
| 43 | |||
| 44 | 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}}. | ||
| 45 | |||
| 46 | = HTTP Proxy = | ||
| 47 | |||
| 48 | {{warning}} | ||
| 49 | WIP: topic is being refactored in new location: [[HTTP Proxy for XWiki>>documentation.xs.admin.installation.http-reverse-proxy.WebHome]] | ||
| 50 | {{/warning}} | ||
| 51 | |||
| 52 | 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. | ||
| 53 | |||
| 54 | * [[Apache HTTPD>>Documentation.AdminGuide.Installation.ApacheHTTPD]] | ||
| 55 | * [[NginX>>Documentation.AdminGuide.Installation.NginX]] | ||
| 56 | |||
| 57 | = Troubleshooting = | ||
| 58 | |||
| 59 | See [[Troubleshooting>>documentation.xs.admin.installation.troubleshooting.WebHome]]. | ||
| 60 | |||
| 61 | == What to do with an empty XWiki? == | ||
| 62 | |||
| 63 | See [[Multiple Instances of XWiki in the Same Container>>documentation.xs.admin.installation.troubleshooting.multiple-instances-container.WebHome]]. | ||
| 64 | |||
| 65 | == Running XWiki behind a proxy server == | ||
| 66 | |||
| 67 | See [[XWiki behind a Proxy Server>>documentation.xs.admin.installation.troubleshooting.xwiki-proxy-server.WebHome]]. | ||
| 68 | |||
| 69 | === Debugging proxy configuration issues === | ||
| 70 | |||
| 71 | See [[Debug Proxy Configuration>>documentation.xs.admin.installation.troubleshooting.xwiki-proxy-server.debug.WebHome]]. | ||
| 72 | |||
| 73 | == Unsupported major.minor version 51.0 == | ||
| 74 | |||
| 75 | 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. | ||
| 76 | |||
| 77 | See [[Install XWiki without Internet>>documentation.xs.admin.installation.install-offline.WebHome]]. | ||
| 78 | |||
| 79 | == Getting an error about SSL certificate == | ||
| 80 | |||
| 81 | See [[]]. | ||
| 82 | |||
| 83 | == "File path too long" on Windows when unzipping == | ||
| 84 | |||
| 85 | See [[]]. |
