Changes for page Creating XWiki Components

Last modified by Simon Urli on 2023/10/10

<
From version < 63.3 >
edited by Vincent Massol
on 2015/07/02
To version < 64.1 >
edited by Vincent Massol
on 2015/10/17
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -413,11 +413,29 @@
413 413  
414 414  = Deploying the Component =
415 415  
416 -Now that we have a functioning Component let's build it and deploy it to a XWiki Enterprise instance:
416 +Now that we have a functioning Component let's build it and deploy it to an XWiki instance. There are 2 ways.
417 417  
418 +== Manually ==
419 +
418 418  * To build the component, issue ##mvn install##. This generates a JAR in the ##target## directory of your project.
419 419  * To install it into a XWiki Enterprise instance, just copy that JAR file in ##XE_WAR_HOME/WEB-INF/lib## where ##XE_WAR_HOME## is where the XWiki Enterprise WAR is deployed.
420 420  
423 +== Using the Extension Manager ==
424 +
425 +The advantage over the Manual way is that you don't need to regularly start/stop your XWiki instance and thus you don't occur the start wait times.
426 +
427 +* Have a running XWiki instance configured with a local Extension Repository pointing to your Maven local Repository. Edit ##xwiki.properties## and make sure you have the following set:(((
428 +extension.repositories=local:maven:file://${sys:user.home}/.m2/repository
429 +extension.repositories=maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public
430 +extension.repositories=extensions.xwiki.org:xwiki:http://extensions.xwiki.org/xwiki/rest/
431 +)))
432 +* Build your component and deploy it in your local Maven repository with ##mvn install##
433 +* Inside your running XWiki instance, go to the Extension Manager in the Admin UI (e.g. ##{{{http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences?editor=globaladmin&section=XWiki.AddExtensions}}}##) and click on Advanced Search and enter your extension's id and version and follow the instructions
434 +
435 +{{warning}}
436 +If you want to redeploy an extension and it's already installed with the same version, the Extension Manager won't let you do so. Thus you'll need to uninstall it first or delete the Extension metadata in the Permanent Directory.
437 +{{/warning}}
438 +
421 421  Your component is now ready for service.
422 422  
423 423  Enjoy!

Get Connected