Wiki source code of Installation
Version 75.4 by Manuel Smeria on 2012/12/06
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). 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 instead 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 6 or greater installed. | ||
| 26 | * A Servlet Container supporting Servlet 2.4. | ||
| 27 | * A minimum of 300MB of heap memory and 96MB of permGen. Recommended values are above 512MB for the heap and 128MB for the permGen (##-Xmx512m -XX:MaxPermSize=128m##)((( | ||
| 28 | {{warning}} | ||
| 29 | Note that storing attachments with the default (in database) storage mechanism is very memory intensive. See the [[administrators guide to attachments>>platform:AdminGuide.Attachments]] for more information about memory cost and the alternative filesystem based attachment store. | ||
| 30 | {{/warning}} | ||
| 31 | ))) | ||
| 32 | * 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]]. | ||
| 33 | |||
| 34 | = Tutorials = | ||
| 35 | |||
| 36 | 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. | ||
| 37 | |||
| 38 | {{warning}} | ||
| 39 | 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. | ||
| 40 | {{/warning}} | ||
| 41 | |||
| 42 | * [[XWiki On Windows (French)>>http://agoncalves.developpez.com/tutoriels/xwiki/creer-un-site-associatif/]] | ||
| 43 | * [[XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (English)>>http://www.howtoforge.com/xwiki-tomcat-mysql-debian-etch]] | ||
| 44 | * [[XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (German)>>http://www.howtoforge.de/howto/xwiki-on-debian-4-etch-tomcat-mysql]] | ||
| 45 | * [[XWiki On Windows - GlassFish - Oracle (Russian)>>http://etvc.myxwiki.org/xwiki/bin/view/UNA/XWikiInstalation]] | ||
| 46 | * [[XWiki on OpenSUSE - Tomcat - MySQL (English)>>http://geistreicher-papierkorb.blogspot.com/2011/03/setting-up-xwiki-on-opensuse-with-mysql.html]] | ||
| 47 | |||
| 48 | = Installation Methods = | ||
| 49 | |||
| 50 | == [[Using a standalone distribution >>AdminGuide.InstallationStandalone]] == | ||
| 51 | |||
| 52 | It provides a built-in XWiki, with a portable database and a lightweight Java container. | ||
| 53 | A 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. | ||
| 54 | |||
| 55 | == [[Using .war package (usable for production)>>AdminGuide.InstallationWAR]] == | ||
| 56 | |||
| 57 | 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. | ||
| 58 | |||
| 59 | == [[Using .deb package (usable for production)>>AdminGuide.InstallationViaAPT]] == | ||
| 60 | |||
| 61 | 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. | ||
| 62 | |||
| 63 | = Troubleshooting = | ||
| 64 | |||
| 65 | 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. | ||
| 66 | |||
| 67 | == Running multiple instances of XWiki in the same container == | ||
| 68 | |||
| 69 | If you get this error: | ||
| 70 | |||
| 71 | {{code}} | ||
| 72 | com.xpn.xwiki.XWikiException: Error number 3 in 0: Could not initialize main XWiki context | ||
| 73 | Wrapped Exception: Failed to get cache factory component | ||
| 74 | ... | ||
| 75 | Caused by: | ||
| 76 | org.infinispan.jmx.JmxDomainConflictException: Domain already registered org.xwiki.infinispan | ||
| 77 | {{/code}} | ||
| 78 | |||
| 79 | 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. | ||
| 80 | |||
| 81 | |||
| 82 | == Running XWiki behind proxy-server == | ||
| 83 | |||
| 84 | 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. | ||
| 85 | |||
| 86 | In such cases you should configure XWiki to know your proxy-server. | ||
| 87 | |||
| 88 | 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. | ||
| 89 | The main idea is to add a set of proxy-related properties to system scope. | ||
| 90 | |||
| 91 | 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: | ||
| 92 | |||
| 93 | ##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** -Xmx1738m -Xms1738m -XX:MaxPermSize=256m $XWIKI_OPTS"## |
