Contents

Installation

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.

There are 2 solutions when installing XWiki:

  • Use the Standalone distribution 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.
  • Use the WAR distribution and configure both your container and your database to work with it.
If you're instead upgrading an existing XWiki install check the Upgrade instructions below.

Pick one of the trails in the outline on the right to get started.

Once you've finished the installation check the other topics in the Admin Guide for configuring and securing your wiki.

If you want to make manual installation or need to migrate an existing XWiki installation, check the Release Notes.

Tutorials

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.

Warning: 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.

Prerequisites

You'll need to have Java 5 installed.

Installing the Standalone distribution

This is by far the easiest way to install XWiki. We are offering 3 packaging for ease of installation:

  • A Windows exe. Simply execute it and follow the instructions
  • A generic Installer that works on all platforms. It requires Java to be installed on your system. Simply double-click on it and follow the instructions.
  • A zip version. Unzip it in any [XWIKIHOME] directory of your choice.
The Windows installer creates shortcuts to start and stop XWiki. If you've used the zip file or generic Installer, go to the directory where you've installed XWiki ([XWIKIHOME]) and run start_xwiki.bat in Windows or start_xwiki.sh on Unix. To stop it, run the stop_xwiki.bat script on Windows and stop_xwiki.sh on Unix.

Once XWiki is started point your browser to http://localhost:8080/xwiki/bin/view/Main/WebHome and the go to the User's Guide to learn how to use XWiki. To change the port, edit the start script and replace 8080 by the number you want.

You can log in using the default Admin user (first letter is capitalized). The default password is 'admin' (lowercase).

Installing the XWiki WAR manually

You'll need to perform 2 mandatory steps:

  • Install and configure a Servlet Container
  • Install and configure a relational database
If your database is empty this will result in a minimal empty wiki installation. You may want to use the Import/Export tool to import some pages in your wiki. We recommend that you import the provided default XAR. If you're upgrading from an existing installation your database should already contain the pages you had before. If you're using the new XWiki 1.0 skin you might want to install the Panels Application.

If you are installing in a linux/unix environment you have to setup the xwiki.upload.tempdir parameter as explained in the JIRA entry (http://jira.xwiki.org/jira/browse/XWIKI-530) before importing anything into XWiki.

Install and configure a Servlet Container

XWiki will work with any Servlet Container. We're only listing instructions for a few containers but you can adapt these instructions for your favorite container.

You're now ready to install and configure your relational database.

Install and configure a Relational Database

XWiki can work with a lot of relational databases. We're only listed those that we have tested it on.

The general strategy is the following:

  • Install your favorite RDBMS
  • Create a xwiki database
  • Create a user with all privileges on that xwiki database
  • Copy your RDBMS Java drivers to the XWiki webapp's WEB-INF/lib directory
  • Configure XWiki to use the created database. This involves modifying the WEB-INF/hibernate.cfg.xml file as is described in the tutorials for each database below. Also make sure that your xwiki.cfg file has an entry that points to your WEB-INF/hibernate.cfg.xml file (xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml) as otherwise your settings won't be used.
Install and configure the database you wish to use:

Concluding Step

At this stage you have finished configuration XWiki. If you start your database and container and point your browser to http://localhost:8080/xwiki/ you'll have a working, albeit minimal, wiki (without any page loaded). The next step is either to create new pages by hand or import the default Wiki that we are providing as a XAR file, by using the Import feature.

Installing the eXo Enterprise WebOS integration WAR

Warning: The integration with eXo is still very experimental and the instructions below are not finalized yet. Proceed with caution!

Install eXo WebOS

  • Download the latest version of eXo Portal on http://forge.objectweb.org/projects/exoplatform/ (version 2.0-Alpha-2 or greater is required).
  • Follow the eXo installation instructions located inside the Portal ZIP and try to login in the portal.

Install XWiki inside eXo

  • Stop eXo Portal.
  • Download the latest XWiki eXo WAR. You'll need version 1.0-beta-6 or above.
  • Create a directory exo-tomcat/webapps/xwiki.
  • Unzip the WAR in exo-tomcat/webapps/xwiki and rename the exploded directory to "xwiki".
  • Move the ehcache.jar from xwiki/WEB-INF/lib to exo-tomcat/common/lib (There are some conflicts with it that both XWiki/eXo will need to fix in future versions).
  • Remove all the eXo jars from xwiki/WEB-INF/lib
  • Configure XWiki's database as explained above.
  • Change in xwiki.cfg: xwiki.exo=1 to xwiki.exo=0. TODO: Explain why this is required as it is very counter-intuitive!
  • Restart eXo Portal.
  • You can now either import XWiki as a Portlet inside the Portal as described below or access XWiki directly by using the usual URL.
  • Change the skin to use the XWiki 1.0 skin. This skin is compatible with the Portlet mode and specifically with eXo WebOS.
  • Import the default wiki XAR or use your own XWiki database.
  • Give the admin right to XWikiGuest
  • To be continued...

Use XWiki inside the WebOS

Inside the WebOS, XWiki is seen as a Portlet and therefore must be imported in eXo through the PortletRegistry application. To do so you need to login as exoadmin / exo in eXo and go to the Administration desktop and use the PortletRegistry application. Click on the "Import Portlet Category" icon, you should now see XWiki in the list. You can now add the Portlet in your desktop page though the "Add Application" icon in the desktop dock.

Installing the Default Wiki XAR

The default wiki is a fully configured wiki that you can use as a starting point for creating your own wiki content. It provides the following:

  • A Blog
  • Photo albums
  • A What's New page
  • The Panels Application
  • Search
  • Administration page (Access rights, Group and users management, etc)
  • … and much more
It comes configured with an "Admin" user (password is "admin" in lowercase). You'll need that username/password to log in once you've imported the default wiki.

To install the XAR, use the Import/Export tool.

Warning: If you're upgrading an existing wiki be careful that the XAR import operation will replace the content of the existing pages of your wiki with the content of the XAR (New pages that you have created will not be modified). As a consequence it's critical that you perform a backup first.

Upgrading an XWiki Installation

There are different parts of XWiki that you may want to upgrade:

If you're upgrading an XWiki 0.9 installation refer to this guide.

Upgrading XWiki Core

The general strategy is to download the WAR distribution and to replace your current installed WAR. Make sure you don't copy on top since this could leave some old files around which would make XWiki fail (like if old JARs are lying around in WEB-INF/lib). Before replacing your current WAR, make sure you back it up and more specifically that you copy the hibernate.cfg.xml and xwiki.cfg files which you'll need to copy in your newly installed WAR since they container your XWiki configuration. Make sure you also copy any plugins you may have added or any template files you may have modified.

Some additional operations may be required for upgrading and you must check the release notes for all the versions from the version you're upgrading from up to the new version you're installing.

Upgrading wiki documents

You may want to upgrade to a newer version of the Default Wiki XAR in order to benefit from the latest changes. As mentioned above in the "Installing the Default Wiki XAR" section you should be very careful and when doing the import make sure you selectively decide what pages you wish to import. More specifically the following pages should be imported with great care:

  • XWiki.XWikiPreferences: This page contains the configuration of your wiki (it overrides the configuration defined in xwiki.cfg). If you import a new version of this page you'll loose any customization you may have made such as the skin to use, the rights for your wiki, etc.
  • XWiki.WebPreferences, Main.WebPreferences, and all other spaces WebPreferences pages: Same as XWiki.XWikiPreferences but at the level of a space.
  • XWiki.XWikiAllGroup (list of registered users) and XWiki.AdminGroup (list of Admins): If you have existing users and import a new version of these pages, you'll find that your users do not belong to these groups anymore and thus may not be able to edit pages, log in, etc. You'll need to add them again to the right groups.
  • Any other page you have modified, such as Main.WebHome, a modified Panel, etc.
Let's clean it up

  • Expand the XWiki WAR that you installed in your servlet container (the one that contains the JDBC drivers to access your database) into a new folder, using jar xvf xwiki-1.1-enterprise.war, or avoid this step if you performed an export/import data migration (you already expanded it)
  • Copy your old xwiki.cfg and hibernate.cfg.xml file to the WEB-INF folder. Take care that if some changes were already made (probably because of database configuration when you installed the JDBC drivers) could be lost, so take car to add these changes
  • Rename the skins/albatross folder to albatross.original, and copy the skins/default folder from XWiki 0.9 to skin/albatross. (WARNING: this is an optional step, in case you don't want to use the default skin for 1.1x and want to retain your current skin in the new version)
  • Install this new folder as the xwiki application in your servlet container (may be by copying the folder to the servlet filesystem space or by packing it in a WAR file and deploying it)

At this point all is set, you can experience our old wiki data over the new XWiki core !!!

Troubleshooting

Field 'XWD_ARCHIVE' doesn't have a default value

If you get an error like the one below it probably means you had an old XWiki version installed (most likely a 0.9 version) which had a wrong schema. We're normally automatically fixing schemas at startup when you set the xwiki.store.hibernate.updateschema configuration parameter in xwiki.cfg (it's set to on by default). However it's currently not done for this error.

Wrapped Exception: Could not execute JDBC batch update
[...]
Wrapped Exception:
java.sql.BatchUpdateException: Field 'XWD_ARCHIVE' doesn't have a default value

To fix this run the following SQL command on your database:

alter table xwikidoc modify column XWD_ARCHIVE mediumtext null;

Failure to log in

Check that you don't have some old cookies and try deleting them.

Version 14.4 last modified by squirrel on 15/05/2008 at 22:19

Comments 28

UDayTangs | 15.12.2006 at 01:33 PM
Will there be XWiki on Oracle database setup details? Xwiki 1.0 beta supports Oracle database?
MaximDim | 22.12.2006 at 08:31 PM
So what's admin password right after install?
DericKho | 23.12.2006 at 03:53 AM
I think it is "admin".
DanMurphy | 26.12.2006 at 11:38 PM
I think the point both the first two comments are making is that XWiki Beta 1 is meant to be capable of runing on an empty db see blog entry?. Personally using Derby I can't get this to work (although it is not clear if the db needs to contain a set of empty tables or can be table-less). Perhaps a discussion for the maining list
JoeFernandez | 04.01.2007 at 02:49 AM
Default administrator login after installation is: Username: Admin ('A' capitalized, not: admin or Administrator) Password: admin (all lowercase)

This user is not available if you just deploy the .war on tomcat or jetty; You must also import the xwiki-1.0-beta-1.xar.xar into your XWiki instance. In which case you might need to know how to enable the superadmin user: (http://www.xwiki.org/xwiki/bin/view/FAQ/HowCanIGetBackAdminRightsWhenIDeletedThemForMeByAccident)

quasimotoca | 12.01.2007 at 12:01 AM
I have virtual hosts setup on my machine. I'm running the standalone on port 9090. I get the following when I go to the wiki page:

Error 404 - Not Found. No context on this server matched or handled this request. Contexts known to this server are: WebApplicationContext/xwiki,xwiki? The links above may not work if a virtual host is configured.

Is there a smaple Vhost config around that I could take a look at?

Cheers, Dave

Aneiba | 17.01.2007 at 11:44 AM
I have installed xwiki.war in my machine, but with embty database and i try to import the xwiki-1.0-beta-1.xar file for default setting, but still did not work. In other words, i can not registr a new user or loging with Admin, admin loging details, do i miss simthing? please help

Regards,

adel

brandone | 17.01.2007 at 02:14 PM
Adel, You need to login as an admin user to do this. I used a previously-populated database and had to revert to the superadmin - this worked like a charm for me (do a search on lost admin permissions for details on how to set this up).
dzhao16 | 25.01.2007 at 04:52 PM
from the old xwiki site I found the note for config oracle. I don't quite understand the step 4 for oracle10g, it said "Add the hibernate user type class from http://www.hibernate.org/56.html? and then ..." what that mean?, Do I need to change the java class...?
tmitchell | 08.02.2007 at 04:26 AM
OK, here goes -- again. I was entering a comment when an error page came up after pasting in some text from a file that apparently wasn't allowed. Anyway...

I installed XWiki into my JBoss installation because I have already been using JBoss for other projects. After logging in with 'admin' and 'admin' for user/password I was able to import the demo .xar that was available, I expect that the personnel at XWiki are still working on the documentation. At first I had a problem with the resource-ref? javax.sql.DataSource in the server-dir?deployxwiki.warWEB-INFweb.xml file, something about the name not being bound and I couldn't get the site to come up.

For the database, I created an empty MySQL database with the appropriate user/pword combo and didn't have any problems with it.

I didn't want to deal with this so I commented it out temporarily to see how far I could get. The next error was a parse error in Log4J, so I removed the log4j-1.2.13.jar file in server-dir?deployxwiki.warWEB-INFlib because I knew that JBoss comes with this file.

After that (and adding a jboss-web.xml file in the WEB-INF dir) I uncommented the resource-ref? I commented out before and now it seems to be running, albeit with tons of errors, but I'm sure this is because I'm using the demo .xar files.

For now I think I'm going to kick back and do some reading -- what a concept (I'm impatient sometimes).

Tom

Boly38 | 07.03.2007 at 10:56 PM
pour les français, voici de quoi démarrer pour la xwiki-1.0-beta-5 avec cette traduction du minimum: Si vous utilisez le package d'installation de Windows (.exe), il suffit de suivre les instructions. Ce dernier crée un raccourci pour démarrer/stopper XWiki. Si vous êtes sur une autre plateforme, récupérez le tar.gz et décompressez le dans le répertoire XWIKIHOME de votre choix. Cette archive procure scripts bat (windows) ou sh (linux) pour démarrer/stopper XWiki.

Une fois XWiki démarré allez sur http://localhost:8080/xwiki/bin/view/Main/WebHome et rendez vous sur le guide utilisateur pour apprendre comment utiliser XWiki. Pour changer le port, éditez le script de démarrage et changer 8080 par un autre nombre.

un peu plus haut dans les commentaires, on trouve le login/pass du super utilisateur, avec attention au respect de la casse (majuscules/minuscules) :

  • login : Admin
  • pass : admin
best regards ;)
Boly38 | 07.03.2007 at 11:01 PM
could somewone say where the french translation is ? if there is not and if an admin can activate french language i will be please to help updating the documentation's translation process…
thefamouseric | 20.03.2007 at 03:01 PM
How do I publish a Informix IDS installation guide ?
thefamouseric | 20.03.2007 at 03:01 PM
How do I publish a Informix IDS installation guide ?
BenWalding | 25.03.2007 at 01:58 PM
To install on resin you need to override the XML parser / document factory.

Add the following to resin.conf

<system-property javax.xml.parsers.DocumentBuilderFactory=
             "org.apache.xerces.jaxp.DocumentBuilderFactoryImpl"/>
<system-property javax.xml.parsers.SAXParserFactory=
             "org.apache.xerces.jaxp.SAXParserFactoryImpl"/>

Also, you will need to edit the web.xml and remove the XWikiDS element: 

<resource-ref>
        <description>DB Connection</description>
        <res-ref-name>jdbc/XWikiDS</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
    </resource-ref>
ArtemMelchuk | 23.05.2007 at 04:05 PM
after deployment rename xwiki 1.0 to xwiki in webapp catalog
ArtemMelchuk | 23.05.2007 at 04:05 PM
after deployment rename xwiki 1.0 to xwiki in webapp catalog
tocasu | 20.08.2007 at 03:11 PM
Anybody successfully installed Xwiki based on ORACLE 10G database. I has created database XWIKI on ORACLE 10G with xwiki user(all privileges is granted), I copied correct version of JDBC driver in WEB-INFlib and modified hibernate.cfg.xml to point oracle database. The error sound something like this: 15:58:08,781 FATAL http-8080-Processor25 http://localhost:8080/xwiki/bin/login/XWiki/XWikiLogin DBCPConnectionProvider:configure:191 - Could not create a DBCP pool org.apache.commons.dbcp.SQLNestedException: Cannot create PoolableConnectionFactory (Io exception: The Network Adapter could not establish the connection).....

Any sugestions will be usefull.... Thanks.

Ghita.

tocasu | 21.08.2007 at 02:46 PM
I tried to install xwiki with MYSQL 5.0 server. I recieved the following error: Error: java.security.NoSuchAlgorithmException: Algorithm DES not available. The problem may be on dhe java version??? I use java 5.0… Somebody installed with no errors XWIKI, except (HSQL version)??
rlsabari | 29.08.2007 at 06:18 AM
I have installed Xwiki successfully, i am not able to login with Admin,admin(pword), even i tried with changing the xwiki configuration file. Pls any know how to set / retrieve / loggin to admin?

thanks in advance Sabarish R L

DieudonneDard | 09.09.2007 at 01:37 PM
Translation in french bellow.

Hello,

for information, the installation on Mac OS X is ok. Except when logging with theses :

  • Admin
  • admin
any idea why ?

Bonjour,

Pour info, l'installation sur Mac OS X se passe comme prévu. Sauf au moment de se connecter ces identifiants :

  • Admin
  • admin
donnent en retour le message suivant : "Nom d'utilisateur erroné" !?

Apparemment je ne suis pas le premier à rencontrer ce bug.

Quelqu'un a une idée de l'origine de ce bug ?

DieudonneDard | 09.09.2007 at 01:37 PM
Translation in french bellow.

Hello,

for information, the installation on Mac OS X is ok. Except when logging with theses :

  • Admin
  • admin
any idea why ?

Bonjour,

Pour info, l'installation sur Mac OS X se passe comme prévu. Sauf au moment de se connecter ces identifiants :

  • Admin
  • admin
donnent en retour le message suivant : "Nom d'utilisateur erroné" !?

Apparemment je ne suis pas le premier à rencontrer ce bug.

Quelqu'un a une idée de l'origine de ce bug ?

cometa | 10.10.2007 at 05:46 PM
I have the next error in a typical installing:

INFO: Instalando aplicaciones web en trayectoria de contexto /xwiki desde URL file:/var/lib/tomcat5/webapps/xwiki 10-oct-2007 11:14:05 org.apache.catalina.core.StandardContext processTlds GRAVE: Error reading tld listeners javax.servlet.ServletException: Excepción durante el tratamiento de la TLD indicada por la trayectoria de recurso /WEB-INF/struts-logic.tld javax.servlet.ServletException: Excepción durante el tratamiento de la TLD indicada por la trayectoria de recurso /WEB-INF/struts-logic.tld at org.apache.catalina.startup.TldConfig.tldScanTld(TldConfig.java:549) at org.apache.catalina.startup.TldConfig.execute(TldConfig.java:301)

Any ideas??? Thank you in advanced.

cometa | 10.10.2007 at 06:04 PM
I set to TOMCAT_SECURITY=no in /etc/default/tomcat5 and it starts!! Thank you.
BarryWadsworth | 11.11.2007 at 04:23 PM
Can anyone recommend a good, inexpensive ISP that provides the required environment?
VincentMassol | 12.11.2007 at 06:28 PM
Barry, sure… http://xwiki.com :)
TmpTmp | 11.12.2007 at 01:23 PM
Hi. I am upgrading from 0.9. to 1.2. I tried to add the export feature to my 0.9 xwiki. I can choose a space to export, but the resulting xar file is empty. What can be wrong?

Tom

xiaocase | 18.02.2008 at 12:04 PM
How to integrate xwiki with the latest exo webos???? It can't work with exo-eXoUltimateProduct-r23239-tomcat.

Attachments 2

Text
prototype.js 1.3
PostedBy: bitman09 on 06/12/2007 (48kb )
Text
xwiki.js 1.3
PostedBy: bitman09 on 06/12/2007 (1kb )
Creator: VincentMassol on 2007/11/19 15:32
This wiki is licensed under a Creative Commons license
1.3.2.9174