Docs menu
MENU

How to Deploy XWiki

You can have a XWiki instance up and running within minutes using one-click install option.

The process is simple - just click Get it hosted now, type your email and install XWiki in a minute skipping the steps of manual installation.

Find the full list of applications available for one-click installation at our Marketplace page.

Manual XWiki Installation

XWiki is a free wiki software platform written in Java with a design emphasis on extensibility.

Let’s deploy XWiki to the platform right now!

Create Environment

1. Log into the platform dashboard.

2. Create a new environment:

create environment button

3. In the Environment Topology dialog, pick your application server (for example, Tomcat) and the database you want to use (for example, MySQL). Then specify your environment name, for example, xwikitest.

XWiki environment topology

It will take just a minute for your environment to be created.

Upload Java Package

1. Navigate to xwiki.org and select Download & Play > XWiki Enterprise.

XWiki download

XWiki WAR package

2. Stop the started downloading and copy the link to the package by right-click on the click here line and choosing Copy link address in the opened menu.

copy link to XWiki package

3. Go back to the platform and upload the package you have just downloaded to the Deployment manager. For that navigate to URL tab and enter there link you’ve just copied.

upload XWiki archive

4. Once the package is in the platform, deploy it to your environment.

deploy XWiki application

Configure Database

1. Click the Open in Browser button for MySQL.

open MySQL in browser

2. When you created the environment, the platform sent you an email with credentials to the database. Use these credentials to create a user account and the database with the application.

database add user

create dedicated database

Configure XWiki

1. Upload MySQL connector to the lib folder.

upload MySQL connector

2. Pick Config for Tomcat and navigate to hibernate.cfg.xml file (webapps/ROOT/WEB-INF)

hibernate.cfg.xml configuration file

3. Comment the part of file which is responsible for the default database configuration, uncomment MySQL configuration and type the correct database connection URL, your database name and password. Also add following lines in the MySQL part as it is shown in the picture below:

1
2
3

<property name="connection.provider_class"<com.xpn.xwiki.store.DBCPConnectionProvider</property>
<property name="connection.pool_size"<2>/property>
<property name="statement_cache.size"<2>/property>

adjust hibernate.cfg.xml

Save the changes and restart Tomcat!

Start XWiki

Now you can open XWiki in a browser and create your spaces and pages there. Enjoy!

XWiki successfully deployed

Hope this instruction will be useful for you.

What’s next?