Plugins

Description

The plugins section allows to connect the special add-ons to your Document Server installation which will help you add additional features to document editors.

Parameters

Name	Description	Type	Example
autostart	Defines the array of the identifiers (as entered in config.json) for the plugins, which will automatically start when the editor opens, and the order the plugins will run one-by-one.	array of string
pluginsData	Defines the array of absolute URLs to the plugin configuration files (config.json).	array of string
url	Defines the absolute URL to the directory where the plugins are stored. Deprecated since version 4.3, please use the absolute URLs in pluginsData field.	string	“https://example.com/plugins/“

Example

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "editorConfig": {
        "plugins": {
             "autostart": [
                 "asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
                 "asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
                 ...
             ],
             "pluginsData": [
                 "https://example.com/plugin1/config.json",
                 "https://example.com/plugin2/config.json",
                 ...
             ]
        },
        ...
    },
    ...
});

Where the example.com is the name of the server where document manager and document storage service are installed and the plugins are placed. See the How it works section to find out more on Document Server service client-server interactions.

If you have any further questions, please contact us at integration@onlyoffice.com.