General Actions:
Extension Module
Last modified by Vincent Massol on 2013/03/11 09:38
 | Manages Extensions (install, uninstall, upgrade) |
| Type | Other |
| Developed by | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Enterprise, XWiki Enterprise Manager |
| Compatibility | XWiki Enterprise > 2.5 |
Description
Allows installing, updating and uninstalling extensions in a running XWiki instance.
The user interface documentation can be found on Extension Manager Application.
See also
Architecture
Core principles:
- The extension manager supports any kind of repository (maven, extensions.xwiki.org, etc.).
- The Extension manager supports any kind of extension (jar, xar, skin, etc.).
- Each extension can have dependencies located in any repository.
- An extension can be installed/upgraded/uninstalled on any wiki or in the whole farm.
Screenshots
See the Extension Manager Application.
Configuring Extension Repositories
You can control the list of Repositories to use by setting the extension.repositories property in your xwiki.properties file. Here's the documentation you'll find when editing xwiki.properties:
#-# [Since 2.5]
#-# Repositories to use when searching and downloading extensions.
#-#
#-# The format is <id>:<type>:<url> where
#-# * id can be anything as long as there is only one
#-# * type is the type of the repository (maven, xwiki, etc.)
#-# * url is the URL or the root of the repository
#-#
#-# The default is:
# extension.repositories=maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
# extension.repositories=extensions.xwiki.org:xwiki:http://extensions.xwiki.org/xwiki/rest/
#-# Repositories to use when searching and downloading extensions.
#-#
#-# The format is <id>:<type>:<url> where
#-# * id can be anything as long as there is only one
#-# * type is the type of the repository (maven, xwiki, etc.)
#-# * url is the URL or the root of the repository
#-#
#-# The default is:
# extension.repositories=maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
# extension.repositories=extensions.xwiki.org:xwiki:http://extensions.xwiki.org/xwiki/rest/
Thus for example if you wish to add your local Maven repository (/.m2/repository in this case) so that you can test an extension you'd have built locally with Maven you'd write:
extension.repositories=local:maven:file://${sys:user.home}/.m2/repository
extension.repositories=maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
extension.repositories=extensions.xwiki.org:xwiki:http://extensions.xwiki.org/xwiki/rest/
extension.repositories=maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
extension.repositories=extensions.xwiki.org:xwiki:http://extensions.xwiki.org/xwiki/rest/
If you wish to add the XWiki Snapshot repo you'd add:
...
extension.repositories=maven-xwiki-snapshot:maven:http://nexus.xwiki.org/nexus/content/groups/public-snapshots/
...
extension.repositories=maven-xwiki-snapshot:maven:http://nexus.xwiki.org/nexus/content/groups/public-snapshots/
...
If you have installed the Repository Application and you wish to add it as a repository you'd add:
...
extension.repositories=localxr:xwiki:http://localhost:8080/xwiki/rest/
...
extension.repositories=localxr:xwiki:http://localhost:8080/xwiki/rest/
...