69 lines
5.6 KiB
Plaintext
69 lines
5.6 KiB
Plaintext
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
|
|
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
|
|
|
|
<script runat="server">
|
|
protected override void Init()
|
|
{
|
|
PageTitle = PageCaption = "Adding new plugins to server editors";
|
|
MetaKeyWords = "ONLYOFFICE Docs, plugins";
|
|
MetaDescription = "Extend the functionality and add new features to the editors by adding new plugins";
|
|
var guides = new GuidesModel();
|
|
guides.TitleVideo = "How to add plugins in self-hosted ONLYOFFICE Docs";
|
|
(Page as BasePage).Guides = guides;
|
|
}
|
|
</script>
|
|
|
|
<div class="MainHelpCenter">
|
|
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Adding new plugins to server editors</h1>
|
|
<cc:localizecontent runat="Server" controlname="~/Controls/Help/VariousControls/Versions/DocumentServer/DocumentServer_Current.ascx" />
|
|
<div class="keyword_block">
|
|
<ul>
|
|
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/local-server/local-server.ascx" /></li>
|
|
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/server-version/server-version.ascx" /></li>
|
|
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/document-server/document-server.ascx" /></li>
|
|
</ul>
|
|
</div>
|
|
<div class="video_ground video_trips">
|
|
<div class="block_of_step">
|
|
<div class="video_text">
|
|
<div class="video_block community_display">
|
|
<a onclick="showVideoContainer();" class="docs_add_plugin_video"><span class="playbackbutton"></span></a>
|
|
</div>
|
|
<p>Extend the functionality and add new features to <b>ONLYOFFICE Docs</b> by adding new plugins.</p>
|
|
<div class="notehelp">
|
|
this guide is only for <b>Self-hosted</b> server versions of ONLYOFFICE Docs. To learn how to add plugins to the <b>Cloud service</b>, please, refer to <a target="_blank" href="https://api.onlyoffice.com/plugin/installation/cloud">this</a> page.
|
|
</div>
|
|
<p>It only takes a few minutes and can easily be done by following the instuctions below:</p>
|
|
<ol>
|
|
<li>Go to <a target="_blank" href="https://www.onlyoffice.com/en/app-directory">App Directory</a> page, where all compatible and ready-to-install plugins are located.</li>
|
|
<li>Select the suitable plugin from the list and make sure that it is compatible with the <b>ONLYOFFICE Docs</b>.</li>
|
|
<li>Click the <b>Install now</b> button, or you can also manually find the repository of the latest available corresponding plugin on ONLYOFFICE <a target="_blank" href="https://github.com/ONLYOFFICE">Github</a> page.
|
|
<p>Here are some examples:</p>
|
|
<ul>
|
|
<li><a target="_blank" href="https://github.com/ONLYOFFICE/plugin-telegram">Telegram</a> - chat with co-authors in real time using integrated Telegram client;</li>
|
|
<li><a target="_blank" href="https://github.com/ONLYOFFICE/plugin-wordscounter">Words counter</a> - count words, characters, and paragraphs in the selected part of your document;</li>
|
|
<li><a target="_blank" href="https://github.com/ONLYOFFICE/plugin-thesaurus">Thesaurus</a> - search for synonyms and antonyms of a word and replace it with the selected one.</li>
|
|
</ul>
|
|
<p>All the currently existing open source plugin examples are available <a target="_blank" href="https://github.com/ONLYOFFICE/sdkjs-plugins">here</a>.</p>
|
|
</li>
|
|
<li>Copy the URL-address of the plugin and download it using termimal:
|
|
<pre><code>git clone https://github.com/ONLYOFFICE/plugin-name </code></pre>
|
|
<p>Where <code>plugin-name</code> is the URL-address of the plugin (e.g. <em>https://github.com/ONLYOFFICE/plugin-wordscounter</em> to download Words counter plugin).</p>
|
|
</li>
|
|
<li>Put the folder with the plugin code to the <code>sdkjs-plugins</code> folder, which is located in the ONLYOFFICE Docs directory.
|
|
<p>For Linux:</p>
|
|
<pre><code>mv plugin-folder /var/www/onlyoffice/documentserver/sdkjs-plugins/</code></pre>
|
|
<p>For Windows:</p>
|
|
<pre><code>move plugin-folder %ProgramFiles%\ONLYOFFICE\DocumentServer\sdkjs-plugins\</code></pre>
|
|
<p>Where <code>plugin-folder</code> is an absolute path plugin directory.</p>
|
|
</li>
|
|
<li>The plugins will be available to all the users of <b>ONLYOFFICE Docs</b>. <a target="_blank" href="https://nodejs.org/docs/latest/api/fs.html#fs_availability">In some cases</a> service restart is required:
|
|
<pre><code>supervisorctl restart all</code></pre>
|
|
</li>
|
|
</ol>
|
|
<p>You can also add new plugins through the <em>config.json</em> file. To find out how to do this, visit our <a target="_blank" href="https://api.onlyoffice.com/plugin/installation/onpremises">for developers</a> page.</p>
|
|
<p>If you want to remove the added or a default plugin, refer to <a target="_blank" href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-uninstall-plugin.aspx")%>">Uninstall default plugins from the server editors</a> guide.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div> |