Getting Started

Version 44.1 by Ecaterina Moraru (Valica) on 2017/08/22
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Welcome to the XWiki "Get Started" page. This guide provides basic information on how to set up and use XWiki. Start by learning more about wikis.

XWiki's use cases are diverse: collaborative intranet, knowledge base, CMS, competitive intelligence, public debate, collaborative creation of school courses, web site creation, etc. Read more on what wikis can be used for, what makes XWiki special and a second generation wiki.

You can visit the references page to see a list of varied projects based on XWiki. You can add your own project to the same page by filling in a short form. You can also go to the XWiki project homepage to see some of the companies that use XWiki or check out the testimonials page to view what our users have to say.

Basic information

The first thing you want to do is make sure you've downloaded and installed XWiki. For first time XWiki users and for users who wish to quickly try out XWiki we recommend installing the standalone distribution. You can also use the playground if you're not looking to install XWiki from scratch.

Then, as you log in to your wiki, the first thing you see is the wiki homepage.

1.png XWiki is divided into Wikis and Pages. Inside a wiki, you can create a hierarchy of pages, by creating pages inside other pages. This feature is called Nested Pages. From this area you can add new pages by clicking the "+" button.

2.png Whenever you want to modify a page, click on the pen edit button, make your changes and save the page. The modified page now replaces the previous version. Each version of the page is stored in the page history and can be reverted to if needed. More page actions, such as Administer, Copy, Rename, Delete, Export, are also available from the last two menus on the right.

3.png From the upper right corner you may click on your profile, or the notifications menu.

4.png By expanding the drawer menu on the right you can access you profile or go to the wiki administration. You can also access the wiki, page or user indexes, as well as add a new wiki.

5.png The dashboard allows users to customize pages by adding gadgets. You can edit/modify the dashboard by editing the page which contains the dashboard. The default dashboard has:

  • A welcome message
  • The pages macro
  • A tags cloud
  • The ability to send messages 
  • The activity stream

6.png Lateral menus are handled using panels. A panel is a widget you can see on the left and right of every page of your wiki in the standard version of XWiki. By default you will see a small sized Applications panel on the left and medium sized panels on the right.

7.png The tabbed area at the bottom of the page features by default comments, attachments, page history, page information.


To see the complete list of features go to the features page. More information on the first steps with XWiki can be found on this page.

If you need more help with your wiki or you'd like to get in touch with the community please visit the support page. There you'll find more information on:

If you're an Administrator

If you're using the Jetty/HSQLDB package, before you perform admin actions, you will need to log in using the following credentials:
Username: Admin
Password: admin

We strongly recommend you change the Admin's password to a secret one as soon as you can.
Otherwise, when you install XWiki from scratch, you are asked to register your own user which will be the owner of the wiki.

The XWiki Platform provides general information for admins that need to customize their wiki application (authentication, DB, performance tuning, etc.). Everything you want to know about administrating XWiki, from installation to backups is available in the Administrator's Guide:

  • Discover how to create users and groups and handle rights on your wiki.
  • Learn how to customize the look and feel of the wiki (skin, color themes, panels, etc.)
  • See how you can backup your wiki, import XAR files to the wiki and much more.
    Failed to execute the [html] macro. Cause: [When using HTML content inline, you can only use inline HTML content. Block HTML content (such as tables) cannot be displayed. Try leaving an empty line before and after the macro.]. Click on this message for details.

If you're a Developer

XWiki is also a second generation wiki. You can build simple applications, extend the platform with custom plugins, or even build complex Web applications. 

XWiki's powerful programming features are documented in the Developer's Guide. A number of applications are built-in, such as the Blog. Additional applications, macros and other extensions are available on the Extensions wiki. The documentation for the XWiki Rendering has a dedicated wiki.

For documentation related to contributing to the XWiki project, visit the XWiki Development Zone

Get Connected