Getting Started

Version 58.1 by Silvia Macovei on 2021/02/16
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.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.UserGuide.GettingStarted.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

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 download and install 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 try it online 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 "Create" button.

2.png Whenever you want to modify a page, click on the "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 log in, register, 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 You can easily edit/modify the content of the first page to replace it with your own content.

6.png Lateral menus are handled using panels. A panel is a widget you can see on the left and/or right of every page of your wiki in the standard version of XWiki. By default you will see a small sized Applications and Navigation panels 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 and page information.



You can check the complete list of features. You can also get started with the first steps or skip directly to more advanced topics.

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:


Get Connected