You are looking at documentation for an older release. Not what you want? See the current release documentation.
Installing an add-on in a docker container
To install add-ons you can use the -e EXO_ADDON_LIST option. It will instruct docker to install a list of indicated add-ons before it starts eXo Platform.
This command starts eXo Platform and installs the add-ons exo-tasks and exo-answers version 1.3.x-SNAPSHOT:
docker run -d \ -p 8080:8080 \ -e EXO_ADDONS_LIST="exo-tasks:1.3.x-SNAPSHOT,exo-answers:1.3.x-SNAPSHOT" \ exoplatform/exo-community
Where EXO_ADDONS_LIST contains the list of add-ons that you want to install in your eXo Platform docker container.
The execution of this command will launch the server startup in background i.e it will not display the server log startup. To display it, just run this command:
docker logs --follow <CONTAINER_ID>
Where the CONTANIER_ID could be known when executing this command:
docker ps -a
Displaying the container logs will print the stacktrace about addons installation:
# ------------------------------------ # # eXo add-ons installation start ... # ------------------------------------ # # installing add-ons from EXO_ADDONS_LIST environment variable: eXo Add-ons Manager v1.2.0-M08 ------------------------------------------------------------------------------- Downloading catalog http://www.exoplatform.com/addons/catalog ............ [OK] Loading add-ons list ..................................................... [OK] Updating cache for catalog http://www.exoplatform.com/addons/catalog ..... [OK] Checking compatibility of the add-on with your eXo platform instance ..... [OK] [WARN] DISCLAIMER : You are about to install an eXo Add-On available on your eXo Platform instance. [WARN] This software is provided "as is" without warranty of any kind, either expressed or implied and such software is to be used at your own risk. [WARN] This software is not covered by eXo's Support Services. Installing exo-tasks:1.3.x-SNAPSHOT Downloading add-on exo-tasks:1.3.x-SNAPSHOT archive ...................... [OK] Checking add-on archive .................................................. [OK] Installing file /opt/exo/webapps/task-management.war ..................... [OK] Installing file /opt/exo/lib/task-management-services.jar ................ [OK] Installing file /opt/exo/lib/task-management-integration.jar ............. [OK] Recording installation details into exo-tasks.status ..................... [OK] Add-on exo-tasks:1.3.x-SNAPSHOT installed. ............................... [OK] eXo Add-ons Manager v1.2.0-M08 ------------------------------------------------------------------------------- Reading catalog cache for http://www.exoplatform.com/addons/catalog ...... [OK] Loading add-ons list ..................................................... [OK] Checking compatibility of the add-on with your eXo platform instance ..... [OK] [WARN] DISCLAIMER : You are about to install an eXo Add-On available on your eXo Platform instance. [WARN] This software is provided "as is" without warranty of any kind, either expressed or implied and such software is to be used at your own risk. [WARN] This software is not covered by eXo's Support Services. Installing exo-answers:1.3.x-SNAPSHOT Downloading add-on exo-answers:1.3.x-SNAPSHOT archive .................... [OK] Checking add-on archive .................................................. [OK] Installing file /opt/exo/lib/answers-services-1.3.x-SNAPSHOT.jar ......... [OK] Installing file /opt/exo/webapps/faq.war ................................. [OK] Installing file /opt/exo/lib/answers-plf-integration-1.3.x-SNAPSHOT.jar .. [OK] Installing file /opt/exo/webapps/answers-extension.war ................... [OK] Recording installation details into exo-answers.status ................... [OK] Add-on exo-answers:1.3.x-SNAPSHOT installed. ............................. [OK] # ------------------------------------ # # eXo add-ons installation done. # ------------------------------------ #
Add-ons listing in a docker container
To list the available add-ons in a running eXo Platform docker container, run this command:
docker exec <CONTAINER_ID> /opt/exo/addon list
To know the add-ons alreadly installed, you should execute this command in a running eXo Platform container:
docker exec <CONTAINER_ID> /opt/exo/addon list --installed
An example for this command output:
Loading add-on details from exo-tasks.status ............................. [OK]
Loading add-on details from exo-answers.status ........................... [OK]
Loading add-on details from exo-es-embedded.status ....................... [OK]
===============================================================================
Installed add-ons
===============================================================================
exo-tasks - eXo Tasks
task and project management for personal and team productivity
+ Installed version : 1.3.x-SNAPSHOT
-------------------------------------------------------------------------------
exo-answers - eXo Answers
eXo Answers
+ Installed version : 1.3.x-SNAPSHOT
-------------------------------------------------------------------------------
exo-es-embedded - ElasticSearch Embedded in eXo Platform
Embed ElasticSearch into eXo Platform
+ Installed version : 2.0.0-M08
-------------------------------------------------------------------------------
To uninstall an add-on:
addon uninstall <addonId>
Uninstalling an add-on in a docker container
To uninstall an add-on, you should add this parameter EXO_ADDONS_REMOVE_LIST with the a comma separated list
of add-ons to uninstall:
docker run -d \ -p 8080:8080 \ -e EXO_ADDONS_REMOVE_LIST="exo-tasks:1.3.x-SNAPSHOT,exo-answers:1.3.x-SNAPSHOT" \ exoplatform/exo-community