Wiki Manager Application

Last modified by Thomas Mortagne on 2024/07/08 00:05
cogManages creation and installation of children Wikis
TypeXAR
Category
Developed by

XWiki Development Team

Active Installs1
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

  Download v5.4.7SourcesIssues

Table of contents

Description

Since XWiki 5.3, this application has been replaced by the Wiki Application, which have the same features but also improve the way we manage subwikis. You should consider using it. This page is here for older versions of XWiki.

This application is incompatible with the new Wiki Application which is bundled by default since XWiki 5.3.

How to use

To access the Wiki Manager Application, go to the page WikiManager.WebHome.

From there you can see wikis you have in your farm and delete, change state, etc. To create new wikis, go to the WikiManager.CreateNewWiki page.

Create new wiki
Learn how to create a new wiki in your installed wiki farm
Edit wiki descriptor
Learn how to modify general wiki configuration such as aliases, https, etc.
Modify wiki aliases
Learn how to add or remove wiki aliases.
Access a wiki
Learn the different ways to target a wiki in the url.

Prerequisites & Installation Instructions

Perform the following steps:

  • Use the Extension Manager UI to install this Wiki Manager Application. You can search for "Wiki Manager Application" in the UI. In case you don't find it you can use the "Advanced Search" and enter the following information:
    • extension id: org.xwiki.platform:xwiki-platform-wiki-manager-ui
    • extension version: 5.0.2 (adapt to the version you wish to install; make it match the version of the XWiki you're using)
  • Verify that the Wiki Manager Application is correctly installed by verifying that it appears in your Application Panel on the right. Alternatively you can navigate to the Wiki Manager home page at http://localhost:8080/xwiki/bin/view/WikiManager/WebHome which should now exist (adapt the URL to your setup).
  • (optional but recommended) Create a wiki server descriptor for the main wiki:
    • Create an XWiki.XWikiServerXwiki page
    • Add an XWiki.XWikiServerClass object in it with the proper domain name. To know more about how to set up the domain name, see the Access a wiki documentation page.

In order for Wiki Manager to be able to create new wikis on demand, you will need to give the correct permissions to your database user. Check the Database documentation.

Prior to XWiki 3.3 you had to perform the following steps:

  1. Install the Application Manager plugin and application (optional).
  2. Install the Wiki Manager plugin.
  3. Install the current application going to the Import section in your wiki's Administration and importing the application's downloaded XAR file.

    If you already have an XWiki.XWikiServerClass class document make sure not to overwrite it at import time unless it contains exactly the same properties. Otherwise you could get a conflict in the descriptors of already existing wikis.

  4. Edit your xwiki.cfg file and add the following entries to activate the plugins:
    xwiki.plugins=\
      [...]
      com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin,\
      com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin

Prior to XWiki 5.0 you also had to:

  • Set your wiki as "virtual" to allow multiple wikis. For this, edit your xwiki.cfg file and set the xwiki.virtual property to 1:
    xwiki.virtual=1

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-wiki-manager-ui 5.4.7):

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected