3rd-Party modules are generally installed into ApiOpenStudio using composer, for example:
composer require 3rd-party/apiopenstudio-plugin
or (directly in composer.json)
{
"repositories": [
{
"type": "vcs",
"url": "https://gitlab.com/laughing_man77/hello_world"
}
],
"require": {
"laughing_man77/hello_world": "dev-master"
}
}
In addition, some modules will require install, uninstall and regular update functions to be run when they are updated. This can be managed by CLI (see install-update-3rd-party-modules) or in the Admin GUI (see below).
¶ View all 3rd-party modules
Click on the Modules button in the menu, and you have the ability to view all modules:
This page will list all modules that are in the system, along with single-click install, update and uninstall buttons wherever appropriate.
¶ Install a 3rd-party module
Not all modules require an install process to work, and will work as soon as you install the code via Composer. However, ApiOpenStudio supports an install process for modules that require it. The install button will only apear if the module requires installing and has not been been installed yet (see the image above).
Clicking on the + button next to the module will install it.
¶ Update a 3rd-party module
If the module requires updates to be run, the update button will appear. Hoevring on the button will display a list of update fiunctions that need to be run. Clicking on the button will execute the update functions.
¶ Uninstall a 3rd-party module
If a module has already been installed, and supports uninstalling, a - button will appear next to the module. Clicking on this will uninstall the module.
Note: Ensure that you uninstall the module (if it supports this), before moving the modules code using Composer.
