DoDWAN can be extended with so called plugins that offer new functionalities to DoDWAN or modify the standard behavior of DoDWAN. A plugin should be installed in the installation tree of DoDWAN (so after the installation of DoDWAN itself), and in order to use a plugin, the command that launches DoDWAN should be complemented with plugin information.
A plugin may depends on another plugin. Hence when installing a plugin, you should take care of dependencies, that is, potentially install other plugins beforehand. To date, information on plugin dependencies are found only in the documentation of each plugin.
Currently, the following plugins are available:
dodwan-napi the generic DoDWAN network API. dodwan-napi-tcp the implementation of the DoDWAN network API based on TCP (depends on dodwan-napi)dodwan-napi-ws the implementation of the DoDWAN network API based on WebSockets (depends on dodwan-napi)dodwan-yjs the server-side of a DoDWAN-based Yjs provider (depends on dodwan-napi-ws)In the following we assume that you have already installed DoDWAN on your system and that you know how to launch DoDWAN.
A plugin comes in the form of a ZIP archive that can be downloaded from the DoDWAN download page
In order to install a plugin, simply unzip the ZIP archive in the $DODWAN_HOME/plugins directory.
After all the plugins you need have been installed, run the following command to download all the external libraries:
dodwan.sh load
When launching DoDWAN, you should put in the shell variable dodwan_plugins the short names of the needed plugins, separated with commas. The list should be ordered so that the first name is the one of the deepest plugin in the dependency hierarchy.
For example, the following command starts DoDWAN with the Websocket Network API plugin (dodwan-napi-ws), and its dependency, the Network API plugin (dodwan-napi):
dodwan_plugins=dodwan-napi,dodwan-napi-ws dodwan.sh start
Note that no plugin specification is needed when stopping DoDWAN
When launched, a plugin may accept parameters to modify its behavior. The list of valid parameters is given in the documentation of the plugin.
Plugin parameters are included in the command line that starts DoDWAN, as Java property definitions specified in the jvm_opts shell variable.
For example, the following command starts DoDWAN with two plugins, and specifies two parameters for the second plugin:
dodwan_plugins=dodwan-napi,dodwan-napi-ws jvm_opts="-Ddodwan_napi_ws.port=80 -Ddodwan_napi_ws.serial_method=bson" dodwan.sh start