helpcenter/helpcenter.r7-office.ru/Web/Controls/Help/APIEditors/Signature.ascx

105 lines
4.4 KiB
Plaintext

<%@ Control Language="C#" Inherits="BaseContentUserControls" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Signature";
MetaDescription = "Статьи документации по API сервера документов.";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Signature</h1>
<p class="dscr">ONLYOFFICE Document Server <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/security.aspx")%>">uses</a> <b>tokens</b> generated using the JSON Web Tokens standard.</p>
<div class="note">This feature is used in <b>Document Server</b> starting with version 4.2</div>
<p>For the validation setup it is necessary to edit the configuration file which can be found at the following path:</p>
<div>For Linux - <em>/etc/onlyoffice/documentserver/<b>default.json</b></em>.</div>
<div>For Windows - <em>%ProgramFiles%\ONLYOFFICE\DocumentServer\config\<b>default.json</b></em>.</div>
<p>Restart the services for the config changes to take effect:</p>
<pre>
supervisorctl restart all
</pre>
<div class="header-gray">Parameters</div>
<table class="table">
<colgroup>
<col style="width: 300px;" />
<col />
<col style="width: 100px;" />
<col style="width: 100px;" />
</colgroup>
<thead>
<tr class="tablerow">
<td>Parameter</td>
<td>Description</td>
<td>Type</td>
<td>Example</td>
</tr>
</thead>
<tbody>
<tr class="tablerow">
<td>services.CoAuthoring.secret.inbox.string</td>
<td>Defines the <em>secret key</em> to generate the token in the <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx")%>">browser</a> for the <b>document editor</b> opening and calling the methods and the <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/request.aspx")%>">requests</a> to the <b>document command service</b> and <b>document conversion service</b>.</td>
<td>string</td>
<td>secret</td>
</tr>
<tr class="tablerow">
<td>services.CoAuthoring.secret.outbox.string</td>
<td>Defines the <em>secret key</em> to generate the token in the <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/request.aspx")%>">requests</a> by <b>document editing service</b> to "callbackUrl" address.</td>
<td>string</td>
<td>secret</td>
</tr>
<tr class="tablerow">
<td>services.CoAuthoring.token.enable.browser</td>
<td>Specifies the enabling the token validation in the <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx")%>">config</a> for the <b>document editor</b> opening and calling the methods.</td>
<td>boolean</td>
<td>false</td>
</tr>
<tr class="tablerow">
<td>services.CoAuthoring.token.enable.request.inbox</td>
<td>Specifies the enabling the token validation in the <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/request.aspx")%>">requests</a> to the <b>document command service</b> and <b>document conversion service</b>.</td>
<td>boolean</td>
<td>false</td>
</tr>
<tr class="tablerow">
<td>services.CoAuthoring.token.enable.request.outbox</td>
<td>Specifies the enabling the token generation for the <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/request.aspx")%>">requests</a> by <b>document editing service</b> to <b>document storage service</b>.</td>
<td>boolean</td>
<td>false</td>
</tr>
</tbody>
</table>
<div class="header-gray">Sample default.json configuration</div>
<pre>
{
"services": {
"CoAuthoring": {
"secret": {
"inbox": {
"string": "secret"
},
"outbox": {
"string": "secret"
},
},
"token": {
"enable": {
"browser": true,
"request": {
"inbox": true,
"outbox": true
}
}
}
}
}
}
</pre>
</div>