Adding plugin

You can upload your own plugins to your server. Starting from version 3.5, the plugins can also be uploaded to the DocSpace SaaS solution. System plugins created by our developers are available by default in both the server and SaaS versions of ONLYOFFICE DocSpace.

note

The total number of plugins on the portal, including system plugins, must not exceed 10.

Enabling system plugins

By default, system plugins are turned off. But you can enable them by following the instructions below:

1. In the lower left corner, click and open the Settings page.

   

2. Go to the Integration section.

3. Open the Plugins tab.

   

4. Enable a plugin with a switcher.

   

After that, the plugin will function automatically unless additional settings need to be specified.

A list of the system plugins can also be found in the Developer Tools section on the Plugins SDK tab. For each plugin there is a link to the plugin repository, where you can find the information about the plugin structure and code.

Configuring plugin settings

To set up a plugin:

1. Click .

2. In the dialog that appears, fill out all the empty fields.

   

Now the plugin is available to use.

Uploading plugins

note

You can upload your own plugins in the DocSpace on-premises solution. In the SaaS solution, this option is available starting from version 3.5.

To upload your own plugins to the DocSpace portal:

1. In the lower left corner, click and open the Settings page.

   

2. Go to the Integration section.

3. Open the Plugins tab.

4. Click the Upload plugin button.

   

5. Choose the plugin archive and click Open.

   note

   The maximum size of the plugin archive and each file within it must not exceed 5 MB. The number of plugin icons must not exceed 10.

   

After that, the plugin will function automatically unless additional settings need to be specified.