To use my own developed plugin on the OnlyOffice web version, I followed the steps provided in the documentation ONLYOFFICE Api Documentation - Adding plugins. However, it doesn’t seem to be working properly. Is there any other way to configure the plugin on one server and use it on multiple devices without having to configure them individually again?
Hello, thank you for contacting forum.onlyoffice.com. I’m sorry to hear that you are having trouble with your plugin on the web version of OnlyOffice Docs.
There are a few possible reasons why your plugin might not work properly on the web version. Here are some steps you can try to troubleshoot the issue:
Make sure that you have followed the instructions for adding plugins to the web version correctly¹. You need to put the plugin folder to the Document Server folder, or just add the corresponding line to the config.json file of the Document Server.
Make sure that your plugin is compatible with the web version of OnlyOffice Docs. Some plugins are only available for the desktop or cloud versions. You can check the EditorsSupport parameter in your plugin config.json file to see which editors your plugin supports⁴.
Make sure that your plugin does not conflict with any other plugins that are installed on the web version. You can try disabling other plugins and see if your plugin works then.
Make sure that your plugin does not have any errors or bugs in its code. You can use the browser console or the developer tools to check for any errors or warnings in your plugin code.
If none of these steps help, please contact our support team at support@onlyoffice.com and provide us with more details about your plugin and the issue you are facing. We will do our best to assist you.
To answer your second question, yes, there is a way to configure the plugin on one server and use it on multiple devices without having to configure them individually again. You can use the pluginsmanager utility that is available starting from version 7.4 of OnlyOffice Docs on-premises⁵. This utility allows you to manage the plugins in OnlyOffice Docs on-premises using commands for installing, removing, restoring, updating, etc. For example, you can use the following command to install a plugin from a URL:
The command you provided is for OnlyOffice Desktop, right? How can I achieve the same functionality in OnlyOffice Docs web version? Currently, I have to first turn on the developer option in the Chrome extension and upload my plugin. Is there a way to skip these steps so that all machines can directly have that plugin available in their OnlyOffice web version?
No, the command I provided is for the OnlyOffice Docs web version, not the desktop version. The desktop version does not require any additional steps to add plugins, as they are already included in the installation package. The web version, however, requires either adding the plugin folder to the server or installing the Chrome extension in the browser.
If you want to skip the steps of turning on the developer option and uploading your plugin in the Chrome extension, you can try the following alternative methods:
You can publish your Chrome extension to the Chrome Web Store, so that other users can easily find and install it from there. You will need to create a developer account and pay a one-time registration fee of $5 to do this. You will also need to follow the Chrome Web Store policies and guidelines for publishing your extension.
You can host your Chrome extension on your own website, so that other users can download and install it from there. You will need to create a manifest.json file and an update.xml file for your extension, and upload them along with your plugin folder to your web server. You will also need to sign your extension with a digital certificate and enable HTTPS on your web server.
You can use a group policy or a master_preferences file to automatically install your Chrome extension on multiple devices. This method is suitable for enterprise or educational environments, where you have administrative access to the devices. You will need to obtain the extension ID and update URL for your extension, and configure them in the policy or preferences file.
These methods will allow you to distribute your plugin more easily and efficiently, without having to configure them individually on each device. However, they may also require some additional steps and resources, such as creating an account, paying a fee, hosting a website, or managing policies. You will have to weigh the pros and cons of each method and choose the one that suits your needs best.
According to the ONLYOFFICE Api Documentation, there are two ways to add plugins to the web version of ONLYOFFICE Docs:
The first way is to put the plugin folder to the Document Server folder, or just add the corresponding line to the config. This way, the plugin will be available for all the users who access the web version of ONLYOFFICE Docs on that server.
The second way is to add the plugin as a Chrome extension. This way, the plugin will be available only for the users who have installed the extension in their Chrome browser.
If you followed the first way and it didn’t work properly, you may need to check the following things:
Make sure that your plugin folder has a valid structure and contains all the required files, such as config.json, index.html, and pluginCode.js. You can refer to this guide for more details on how to build your own plugin.
Make sure that your plugin folder has a unique name and a unique guid in the config.json file. You can use this tool to generate a random guid for your plugin.
Make sure that your plugin folder is located in the correct path on the server. The default path is /var/www/onlyoffice/documentserver/sdkjs-plugins/, but you can change it in the /etc/onlyoffice/documentserver/default.json file.
Make sure that you have restarted the Document Server service after adding or modifying your plugin folder. You can use this command to restart the service: sudo supervisorctl restart all
If you followed the second way and it didn’t work properly, you may need to check the following things:
Make sure that your plugin folder has a valid structure and contains all the required files, such as config.json, index.html, and pluginCode.js. You can refer to this guide “Plugins in ONLYOFFICE: A quick start guide for developers. Plugins in ONLYOFFICE: A quick start guide for developers | ONLYOFFICE Blog” for more details on how to build your own plugin.
Make sure that your plugin folder has a unique name and a unique guid in the config.json file. You can use this tool to generate a random guid for your plugin.
Make sure that your baseUrl in the config.json file is set to an empty string (""). This will make the plugin use relative paths to load its resources.
Make sure that you have packed your plugin folder into a zip archive and changed its extension to .crx. You can use this tool to create a Chrome extension from your zip archive.
Make sure that you have installed your Chrome extension in your browser. You can follow these steps to install it manually.
I hope it gives you some ideas to solve your problem.
