Wiki source code of Installation
Version 71.1 by Guillaume Fenollar on 2012/01/25
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 2 solutions when installing XWiki: | ||
| 8 | |||
| 9 | * Use the [[Standalone distribution>>xwiki:Main.Download]] 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>>xwiki:Main.Download]] and configure both your container and your database to work with it. | ||
| 11 | |||
| 12 | If you're instead upgrading an existing XWiki install check the [[Upgrade instructions>>#HUpgradinganXWikiInstallation]] below. | ||
| 13 | |||
| 14 | Pick one of the trails in the outline on the right to get started. | ||
| 15 | |||
| 16 | Once you've finished the installation check the other topics in the [[Admin Guide>>AdminGuide.WebHome]] for configuring and [[securing>>Security]] your wiki. | ||
| 17 | |||
| 18 | {{info}} | ||
| 19 | If you want to make manual installation or need to migrate an existing XWiki installation, check the [[Release Notes>>xwiki:ReleaseNotes.WebHome]]. | ||
| 20 | {{/info}} | ||
| 21 | |||
| 22 | = Tutorials = | ||
| 23 | |||
| 24 | 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. | ||
| 25 | |||
| 26 | {{warning}} | ||
| 27 | 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. | ||
| 28 | {{/warning}} | ||
| 29 | |||
| 30 | * [[XWiki On Windows (French)>>http://agoncalves.developpez.com/tutoriels/xwiki/creer-un-site-associatif/]] | ||
| 31 | * [[XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (English)>>http://www.howtoforge.com/xwiki-tomcat-mysql-debian-etch]] | ||
| 32 | * [[XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (German)>>http://www.howtoforge.de/howto/xwiki-on-debian-4-etch-tomcat-mysql]] | ||
| 33 | * [[XWiki On Windows - GlassFish - Oracle (Russian)>>http://etvc.myxwiki.org/xwiki/bin/view/UNA/XWikiInstalation]] | ||
| 34 | * [[XWiki on OpenSUSE - Tomcat - MySQL (English)>>http://geistreicher-papierkorb.blogspot.com/2011/03/setting-up-xwiki-on-opensuse-with-mysql.html]] | ||
| 35 | |||
| 36 | = Prerequisites = | ||
| 37 | |||
| 38 | * Java 6 or greater installed. | ||
| 39 | * A minimum of 300MB of heap memory and 96MB of permGen. Recommended value are above 512MB for the heap and 128MB for the permGen (##-Xmx512m -XX:MaxPermSize=128m##)((( | ||
| 40 | {{warning}} | ||
| 41 | 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. | ||
| 42 | {{/warning}} | ||
| 43 | ))) | ||
| 44 | * Check the [[Release Notes>>xwiki:ReleaseNotes.WebHome]] for the version you're installing to see what Browsers are supported for it. You can also check our [[general Browser support strategy>>dev:Community.BrowserSupportStrategy]]. | ||
| 45 | |||
| 46 | |||
| 47 | = Installation Methods = | ||
| 48 | |||
| 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 | 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 | |||
| 56 | == [[Using .war package (usable for production)>>AdminGuide.InstallationWAR]] == | ||
| 57 | |||
| 58 | It provides a java application package that have to be installed in a Java container (such as Tomcat). This can be used on almost every operating systems. | ||
| 59 | |||
| 60 | |||
| 61 | == [[Using .deb package (usable for production)>>AdminGuide.InstallationViaAPT]] == | ||
| 62 | |||
| 63 | 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. | ||
| 64 | |||
| 65 | = Troubleshooting = | ||
| 66 | |||
| 67 | You can verify some basic settings of your XWiki install (on Tomcat, MySQL) using the [[Admin Tools application>>extensions:Extension.AdminTools]]. Keep in mind that some of these tools only work in a Linux environment. |
