Add new plugins

From OS4X
Jump to navigation Jump to search

Adding plugins

By adding new plugins to the OS4X plugin list, you're able to use these plugins in a configurable way your business logic needs it. Usable plugins can be used in any plugin group.

Adding automatically (via web interface)

The easiest way to insert a new plugin to OS4X is via the web interface, as long your web server is the same server OS4X itself is running on and your PHP configuration supports file transfers. If this meets your standard installation, you can simply upload the available plugin for your OS4X platform using a file upload mechanism: Click on the left menu on "Plugins", in the new page on the upper left corner on the "new" icon:

Upload-plugin-1.png

In the new form, select a file via the "browse" button (which depends on your language of your browser) and click on "upload executable plugin".

Upload-plugin-2.png

That's it! Your plugin is copied to the plugins directory, included in the plugin list, added completely automatically with all its configuration parameters.

Adding automatically (via command line)

Adding (official) plugins via command line is also quite easy: move the plugin to the OS4X plugin directory (because the installation process expects the plugin at it's first found position).

Example:

mv /tmp/os4xplugin_promata_recipient2 /opt/os4x/plugins/

Then start the plugin with the parameter "-a" and with its complete absolute path information:

/opt/os4x/plugins/os4xplugin_promata_recipient2 -a

Normally, no output should appear on the console. The plugin is now installed correctly.

This only works for binary plugins which use the official mechanisms for OS4X plugin configuration and standards, which will be released soon. If you want to develop such plugins on your own, please contact us.