Warning
You are looking at documentation for an older release. Not what you want? See the current release documentation.
There are 2 ways to deploy an add-on:
Manually install WARs and JARs and other files into the
webapps,libfolders and the corresponding directories of eXo Platform.Use the Add-ons Manager - the standard way to install, uninstall, and update add-ons in eXo Platform. In this way, you will avoid the manual registration that might cause errors. The Add-on Manager allows you to simplify your add-ons management in both Tomcat and JBoss EAP by copying all JARs and WARs in one step and uninstalling them without searching in the
libdirectory (more than 400 jars) and in thewebappsdirectory (more than 50 wars).
When using the Add-ons Manager,you can:
Deploy an add-on from the eXo Add-ons repository, as detailed in Administrator Guide - Installing/Uninstalling add-ons. However, to follow in this way, the add-on should be first registered and validated by eXo administrators.
Deploying a local add-on, as below.
Deploying a local add-on
Let's say you want to deploy your add-on archived as my-addon-1.0.x-SNAPSHOT.zip, do as follows:
Create a local catalog named
local.jsonunder$PLATFORM_HOME/addons/with the minimal content. This local catalog will be merged with the central one at runtime. See here for information included in each catalog entry.[
{
"id": "exo-my-addon",
"version": "1.0.x-SNAPSHOT",
"name": "My Add-on",
"description": "Example of my add-on",
"downloadUrl": "file://D:/java/exo-working/PLATFORM_versions/my-addon-1.0.x-SNAPSHOT.zip",
"vendor": "eXo platform",
"license": "LGPLv3",
"supportedDistributions": ["community","enterprise"],
"supportedApplicationServers": ["tomcat","jboss"]
}
]
Install your own add-on with the script:
addon(.bat) --install exo-my-addon:1.0.x-SNAPSHOT
Now you will see your own add-on zip file in $PLATFORM_HOME/addons/archives.