Skip to main content

Plugins

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

autostart​

Type: array of string

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.

Example: ["asc.{7327FC95-16DA-41D9-9AF2-0E7F449F6800}"]

options​

Type: object

Defines an object which allows configuring plugins from an external source. The settings can be set for all plugins or for a specific plugin. For example, this object can be used to pass an authorization token to the plugin. You can also use the SetPluginsOptions method of the Automation API to pass the options object to the plugin.

Example:

{
  "all": {},
  "pluginGuid": {}
}

options.all​

Type: object

Defines the parameters which will be set for all plugins.

Example:

{
  "all": {
    "keyAll": "valueAll"
  }
}

options.pluginGuid​

Type: object

Defines the parameters which will be set for a specific plugin. The plugin must be specified with the plugin GUID of the asc.{UUID} type.

Example:

{
  "asc.{38E022EA-AD92-45FC-B22B-49DF39746DB4}": {
    "keyYoutube": "valueYoutube"
  }
}

pluginsData​

Type: array of string

Defines the array of absolute URLs to the plugin configuration files (config.json).

Example: ["https://example.com/plugins/chess-plugin/config.json"]

url​

Type: string

Defines the absolute URL to the directory where the plugins are stored.

Deprecated

Starting from version 4.3, please use the absolute URLs in pluginsData field instead.

Example: https://example.com/plugins/

PluginsPlugins

Example​

const config = {
  editorConfig: {
    plugins: {
      autostart: [
        "asc.{7327FC95-16DA-41D9-9AF2-0E7F449F6800}",
      ],
      options: {
        "all": {
          keyAll: "valueAll",
        },
        "asc.{38E022EA-AD92-45FC-B22B-49DF39746DB4}": {
          keyYoutube: "valueYoutube",
        },
      },
      pluginsData: [
        "https://example.com/plugins/chess-plugin/config.json",
      ],
      url: "https://example.com/plugins/",
    },
  },
};

const docEditor = new DocsAPI.DocEditor("placeholder", config);

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 ONLYOFFICE Docs service client-server interactions.