Wiki source code of Installation
Version 90.1 by Vincent Massol on 2015/03/16
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 (HSQL, MySQL, etc) but XWiki and the database need to be setup correctly. | ||
| 6 | |||
| 7 | There are 3 ways of installing XWiki: | ||
| 8 | |||
| 9 | * Use the [[Standalone distribution>>AdminGuide.InstallationStandalone]] 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. | ||
| 10 | * Use the [[WAR distribution>>AdminGuide.InstallationWAR]] and configure both your container and your database to work with it. | ||
| 11 | * Use the [[.deb package>>AdminGuide.InstallationViaAPT]] to install the last version of XWiki and the dependencies. | ||
| 12 | |||
| 13 | If you're upgrading an existing XWiki install check the [[Upgrade instructions page>>AdminGuide.Upgrade]]. | ||
| 14 | |||
| 15 | Pick one of the trails in the outline on the right to get started. | ||
| 16 | |||
| 17 | Once you've finished the installation check the other topics in the [[Admin Guide>>AdminGuide.WebHome]] for configuring and [[securing>>Security]] your wiki. | ||
| 18 | |||
| 19 | {{info}} | ||
| 20 | If you want to make a manual installation or need to migrate an existing XWiki installation, check the [[Release Notes>>xwiki:ReleaseNotes.WebHome]]. | ||
| 21 | {{/info}} | ||
| 22 | |||
| 23 | = Prerequisites = | ||
| 24 | |||
| 25 | * Java 7 or greater installed (Java 6 or greater for XWiki versions < 6.0) | ||
| 26 | * A Servlet Container supporting Servlet 3.0.1 (Servlet 2.4 for XWiki versions < 7.0) | ||
| 27 | * Enough memory, check the [[Memory section>>AdminGuide.Performances#HMemory]] of the [[Performance Guide>>AdminGuide.Performances]]. | ||
| 28 | * Check the [[release notes>>xwiki:ReleaseNotes.WebHome]] for the version you're installing to see what browsers and databases are supported for it. You can also check our [[general support strategy>>dev:Community.SupportStrategy]]. | ||
| 29 | |||
| 30 | = Tutorials = | ||
| 31 | |||
| 32 | Tutorials are step by step procedures to install XWiki for a specific configuration. You can choose to follow one of them or follow the instructions in the sections below. | ||
| 33 | |||
| 34 | {{warning}} | ||
| 35 | Tutorials external to the xwiki.org site have not been validated for correctness by the XWiki dev team and it's also possible that they are out of date. | ||
| 36 | {{/warning}} | ||
| 37 | |||
| 38 | * [[XWiki On OpenShift (Platform-as-a-Service)>>https://github.com/rkmallik/xwiki-example]] | ||
| 39 | * [[XWiki On Windows (French)>>http://agoncalves.developpez.com/tutoriels/xwiki/creer-un-site-associatif/]] | ||
| 40 | * [[XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (English)>>http://www.howtoforge.com/xwiki-tomcat-mysql-debian-etch]] | ||
| 41 | * [[XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (German)>>http://www.howtoforge.de/howto/xwiki-on-debian-4-etch-tomcat-mysql]] | ||
| 42 | * [[XWiki On Windows - GlassFish - Oracle (Russian)>>http://etvc.myxwiki.org/xwiki/bin/view/UNA/XWikiInstalation]] | ||
| 43 | * [[XWiki on OpenSUSE - Tomcat - MySQL (English)>>http://geistreicher-papierkorb.blogspot.com/2011/03/setting-up-xwiki-on-opensuse-with-mysql.html]] | ||
| 44 | * [[XWiki On Archlinux - Tomcat - hsql or MySQL (English)>>https://github.com/xwiki-contrib/packaging-archlinux]] | ||
| 45 | |||
| 46 | = Installation Methods = | ||
| 47 | |||
| 48 | == [[Using a standalone distribution >>AdminGuide.InstallationStandalone]] == | ||
| 49 | |||
| 50 | It provides a built-in XWiki, with a portable database and a lightweight Java container. | ||
| 51 | |||
| 52 | 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 two other options. | ||
| 53 | |||
| 54 | == [[Using .war package (usable for production)>>AdminGuide.InstallationWAR]] == | ||
| 55 | |||
| 56 | It 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. | ||
| 57 | |||
| 58 | == [[Using .deb package (usable for production)>>AdminGuide.InstallationViaAPT]] == | ||
| 59 | |||
| 60 | It 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. | ||
| 61 | |||
| 62 | == Using yaourt on Arch Linux == | ||
| 63 | |||
| 64 | [[To install or upgrade on Arch Linux>>https://github.com/xwiki-contrib/packaging-archlinux]]: {{code language="none"}}yaourt -S xwiki-enterprise{{/code}}. | ||
| 65 | |||
| 66 | = Troubleshooting = | ||
| 67 | |||
| 68 | 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. | ||
| 69 | |||
| 70 | == Running multiple instances of XWiki in the same container == | ||
| 71 | |||
| 72 | If you get this error: | ||
| 73 | |||
| 74 | {{code}} | ||
| 75 | com.xpn.xwiki.XWikiException: Error number 3 in 0: Could not initialize main XWiki context | ||
| 76 | Wrapped Exception: Failed to get cache factory component | ||
| 77 | ... | ||
| 78 | Caused by: | ||
| 79 | org.infinispan.jmx.JmxDomainConflictException: Domain already registered org.xwiki.infinispan | ||
| 80 | {{/code}} | ||
| 81 | |||
| 82 | You need to edit ##WEB-INF/cache/infinispan/config.xml## for each instance of XWiki, and change the ##jmxDomain## value (found under the ##globalJmxStatistics## tag) to have a unique name. | ||
| 83 | |||
| 84 | == Running XWiki behind proxy-server == | ||
| 85 | |||
| 86 | 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. | ||
| 87 | |||
| 88 | In such cases you should configure XWiki to know your proxy-server. | ||
| 89 | |||
| 90 | 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. | ||
| 91 | The main idea is to add a set of proxy-related properties to system scope. | ||
| 92 | |||
| 93 | 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: | ||
| 94 | |||
| 95 | ##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"## | ||
| 96 | |||
| 97 | == Unsupported major.minor version 51.0 == | ||
| 98 | |||
| 99 | 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. | ||
| 100 | |||
| 101 | == Installing without internet connection == | ||
| 102 | |||
| 103 | Three solutions: | ||
| 104 | |||
| 105 | * Set up a local Extension Repository, either as a Maven Repository or using the [[Extension Repository Application>>extensions:Extension.Repository Application]]. Of course you'll need to prefill it with all the extensions you'll wish to install when offline, which isn't something easy to do. | ||
| 106 | * [[Install the Standalone Distribution>>platform:AdminGuide.InstallationStandalone]] which contains a default set of wiki pages. | ||
| 107 | * Do not use the Distribution Wizard and [[import default wiki pages using the XAR Import feature>>AdminGuide.InstallationConcludingSteps]]. |
