Extend the functionality and add new features to ONLYOFFICE Docs by adding new plugins.
this guide is only for
Self-hosted server versions of ONLYOFFICE Docs. To learn how to add plugins to the
Cloud service, please, refer to
this page.
It only takes a few minutes and can easily be done by following the instuctions below:
- Go to App Directory page, where all compatible and ready-to-install plugins are located.
- Select the suitable plugin from the list and make sure that it is compatible with the ONLYOFFICE Docs.
- Click the Install now button, or you can also manually find the repository of the latest available corresponding plugin on ONLYOFFICE Github page.
Here are some examples:
- Telegram - chat with co-authors in real time using integrated Telegram client;
- Words counter - count words, characters, and paragraphs in the selected part of your document;
- Thesaurus - search for synonyms and antonyms of a word and replace it with the selected one.
All the currently existing open source plugin examples are available here.
- Copy the URL-address of the plugin and download it using terminal:
git clone https://github.com/ONLYOFFICE/plugin-name
Where plugin-name is the URL-address of the plugin (e.g. https://github.com/ONLYOFFICE/plugin-wordscounter to download Words counter plugin).
- Put the folder with the plugin code to the
sdkjs-plugins folder, which is located in the ONLYOFFICE Docs directory.
For Linux:
mv plugin-folder /var/www/onlyoffice/documentserver/sdkjs-plugins/
For Windows:
move plugin-folder %ProgramFiles%\ONLYOFFICE\DocumentServer\sdkjs-plugins\
Where plugin-folder is an absolute path plugin directory.
- The plugins will be available to all the users of ONLYOFFICE Docs. In some cases service restart is required:
systemctl restart ds-converter ds-docservice ds-example ds-metrics
You can also add new plugins through the config.json file. To find out how to do this, visit our for developers page.
Plugins can also be managed in the Plugin Manager available in the editors. To learn more, please read the following article.
If you want to remove the added or a default plugin, refer to Uninstall default plugins from the server editors guide.