updated docs config for v7.2
This commit is contained in:
parent
e16db04f8c
commit
1cf0acf960
@ -842,6 +842,68 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 id="Tenants">Tenants</h2>
|
||||
<div class="block_of_step">
|
||||
<div class="screen_text">
|
||||
<table class="table_portslist script_parameters">
|
||||
<colgroup>
|
||||
<col style="width: 270px;" />
|
||||
<col />
|
||||
<col style="width: 150px;" />
|
||||
<col style="width: 250px;" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="tenants-baseDir"><code>tenants.baseDir</code></div></td>
|
||||
<td>Defines a directory that limits the files that can be accessed by <b>ONLYOFFICE Docs</b>.</td>
|
||||
<td>string</td>
|
||||
<td><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="tenants-baseDomain"><code>tenants.baseDomain</code></div></td>
|
||||
<td>Defines the tenant base domain name.</td>
|
||||
<td>string</td>
|
||||
<td><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="tenants-filenameSecret"><code>tenants.filenameSecret</code></div></td>
|
||||
<td>Defines the <em>.pem</em> filename where the tenant secret key is stored.</td>
|
||||
<td>string</td>
|
||||
<td><code>"secret.key"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="tenants-filenameLicense"><code>tenants.filenameLicense</code></div></td>
|
||||
<td>Defines the filename where the tenant license is stored.</td>
|
||||
<td>string</td>
|
||||
<td><code>"license.lic"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="tenants-defaultTenant"><code>tenants.defaultTenant</code></div></td>
|
||||
<td>Defines the domain name of the default tenant.</td>
|
||||
<td>string</td>
|
||||
<td><code>"localhost"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>These parameters define the tenants properties.</p>
|
||||
<h4>Example</h4>
|
||||
<pre><code>"tenants": {
|
||||
"baseDir" : "",
|
||||
"baseDomain" : "",
|
||||
"filenameSecret" : "secret.key",
|
||||
"filenameLicense" : "license.lic",
|
||||
"defaultTenant" : "localhost"
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 id="Services">Document Server services</h2>
|
||||
<div class="block_of_step">
|
||||
<div class="screen_text">
|
||||
@ -935,7 +997,7 @@
|
||||
<p>This parameter is sent to the <b>npm</b> module.</p>
|
||||
</td>
|
||||
<td>string</td>
|
||||
<td><code>"10s"</code></td>
|
||||
<td><code>"2m"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-server-limits_image_download_timeout-wholeCycle"><code>services.CoAuthoring.server.limits_image_download_timeout.wholeCycle</code></div></td>
|
||||
@ -960,13 +1022,13 @@
|
||||
<p>This parameter is sent to the <b>npm</b> module.</p>
|
||||
</td>
|
||||
<td>string</td>
|
||||
<td><code>"10s"</code></td>
|
||||
<td><code>"10m"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-server-callbackRequestTimeout-wholeCycle"><code>services.CoAuthoring.server.callbackRequestTimeout.wholeCycle</code></div></td>
|
||||
<td>Defines the whole request cycle timeout.</td>
|
||||
<td>string</td>
|
||||
<td><code>"2m"</code></td>
|
||||
<td><code>"10m"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-server-healthcheckfilepath"><code>services.CoAuthoring.server.healthcheckfilepath</code></div></td>
|
||||
@ -1053,12 +1115,12 @@
|
||||
"limits_tempfile_upload": 104857600,
|
||||
"limits_image_size": 26214400,
|
||||
"limits_image_download_timeout": {
|
||||
"connectionAndInactivity": "10s",
|
||||
"connectionAndInactivity": "2m",
|
||||
"wholeCycle": "2m"
|
||||
},
|
||||
"callbackRequestTimeout": {
|
||||
"connectionAndInactivity": "10s",
|
||||
"wholeCycle": "2m"
|
||||
"connectionAndInactivity": "10m",
|
||||
"wholeCycle": "10m"
|
||||
},
|
||||
"healthcheckfilepath": "../public/healthcheck.docx",
|
||||
"savetimeoutdelay": 5000,
|
||||
@ -1068,7 +1130,7 @@
|
||||
"maxRequestChanges": 20000,
|
||||
"openProtectedFile": true,
|
||||
"editorDataStorage": "editorDataRedis",
|
||||
"assemblyFormatAsOrigin": false,
|
||||
"assemblyFormatAsOrigin": true,
|
||||
"newFileTemplate" : "../../document-templates/new",
|
||||
"downloadFileAllowExt": ["pdf"],
|
||||
"tokenRequiredParams" : true
|
||||
@ -1572,7 +1634,7 @@
|
||||
<div class="notehelp">Please note that by inactivity we mean the absence of any action in the editor, including cursor movement.</div>
|
||||
</td>
|
||||
<td>string</td>
|
||||
<td><code>"0"</code></td>
|
||||
<td><code>"1h"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-expire-sessionabsolute"><code>services.CoAuthoring.expire.sessionabsolute</code></div></td>
|
||||
@ -1630,7 +1692,7 @@
|
||||
"files": 86400,
|
||||
"filesCron": "00 00 */1 * * *",
|
||||
"filesremovedatonce": 100,
|
||||
"sessionidle": "0",
|
||||
"sessionidle": "1h",
|
||||
"sessionabsolute": "30d",
|
||||
"sessionclosecommand": "2m",
|
||||
"pemStdTTL": "1h",
|
||||
@ -1776,37 +1838,6 @@
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-secret-browser"><code>services.CoAuthoring.secret.browser</code></div></td>
|
||||
<td>
|
||||
<p>Defines the parameters of a secret key to generate a token in the client-side browser requests to ONLYOFFICE Docs:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<b>string</b> - the secret key,
|
||||
<br />
|
||||
<b>type</b>: string,
|
||||
<br />
|
||||
<b>example</b>: "secret";
|
||||
</li>
|
||||
<li>
|
||||
<b>file</b> - the PEM file where the secret is stored,
|
||||
<br />
|
||||
<b>type</b>: string,
|
||||
<br />
|
||||
<b>example</b>: "";
|
||||
</li>
|
||||
<li>
|
||||
<b>tenants</b> - a collection of tenants with their issuers,
|
||||
<br />
|
||||
<b>type</b>: object,
|
||||
<br />
|
||||
<b>example</b>: {}.
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>object</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-secret-inbox"><code>services.CoAuthoring.secret.inbox</code></div></td>
|
||||
<td>
|
||||
@ -1824,14 +1855,7 @@
|
||||
<br />
|
||||
<b>type</b>: string,
|
||||
<br />
|
||||
<b>example</b>: "";
|
||||
</li>
|
||||
<li>
|
||||
<b>tenants</b> - a collection of tenants with their issuers,
|
||||
<br />
|
||||
<b>type</b>: object,
|
||||
<br />
|
||||
<b>example</b>: {}.
|
||||
<b>example</b>: "".
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
@ -1893,8 +1917,7 @@
|
||||
<pre><code>"services": {
|
||||
"CoAuthoring": {
|
||||
"secret": {
|
||||
"browser": {"string": "secret", "file": "", "tenants": {}},
|
||||
"inbox": {"string": "secret", "file": "", "tenants": {}},
|
||||
"inbox": {"string": "secret", "file": ""},
|
||||
"outbox": {"string": "secret", "file": ""},
|
||||
"session": {"string": "secret", "file": ""}
|
||||
}
|
||||
@ -1951,18 +1974,6 @@
|
||||
<td>boolean</td>
|
||||
<td><code>false</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-token-browser"><code>services.CoAuthoring.token.browser</code></div></td>
|
||||
<td>Defines the browser token configuration.</td>
|
||||
<td>object</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-token-browser-secretFromInbox"><code>services.CoAuthoring.token.browser.secretFromInbox</code></div></td>
|
||||
<td>Defines if the browser token is equal to the token from the incoming requests (<code>true</code>) or not (<code>false</code>).</td>
|
||||
<td>boolean</td>
|
||||
<td><code>true</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-token-inbox"><code>services.CoAuthoring.token.inbox</code></div></td>
|
||||
<td>Defines the configuration of a token from the incoming requests.</td>
|
||||
@ -1981,6 +1992,12 @@
|
||||
<td>string</td>
|
||||
<td><code>"Bearer "</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-token-inbox-inBody"><code>services.CoAuthoring.token.inbox.inBody</code></div></td>
|
||||
<td>Defines if a token is enabled in the incoming request body or not.</td>
|
||||
<td>boolean</td>
|
||||
<td><code>false</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-token-outbox"><code>services.CoAuthoring.token.outbox</code></div></td>
|
||||
<td>Defines the configuration of a token from the outgoing requests.</td>
|
||||
@ -2011,6 +2028,12 @@
|
||||
<td>string</td>
|
||||
<td><code>"5m"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-token-outbox-inBody"><code>services.CoAuthoring.token.outbox.inBody</code></div></td>
|
||||
<td>Defines if a token is enabled in the outgoing request body or not.</td>
|
||||
<td>boolean</td>
|
||||
<td><code>false</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-token-outbox-urlExclusionRegex"><code>services.CoAuthoring.token.outbox.urlExclusionRegex</code></div></td>
|
||||
<td>Defines the regular expression that specifies URLs from which the authorization should be excluded. The empty string means that this option is disabled.</td>
|
||||
@ -2061,18 +2084,17 @@
|
||||
"outbox": false
|
||||
}
|
||||
},
|
||||
"browser": {
|
||||
"secretFromInbox": true
|
||||
},
|
||||
"inbox": {
|
||||
"header": "Authorization",
|
||||
"prefix": "Bearer "
|
||||
"prefix": "Bearer ",
|
||||
"inBody": false
|
||||
},
|
||||
"outbox": {
|
||||
"header": "Authorization",
|
||||
"prefix": "Bearer ",
|
||||
"algorithm": "HS256",
|
||||
"expires": "5m"
|
||||
"expires": "5m",
|
||||
"inBody": false,
|
||||
"urlExclusionRegex": ""
|
||||
},
|
||||
"session": {
|
||||
@ -2134,6 +2156,44 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 id="Themes">Themes</h2>
|
||||
<div class="block_of_step">
|
||||
<div class="screen_text">
|
||||
<table class="table_portslist script_parameters">
|
||||
<colgroup>
|
||||
<col style="width: 290px;" />
|
||||
<col />
|
||||
<col style="width: 150px;" />
|
||||
<col style="width: 260px;" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="services-CoAuthoring-themes-uri"><code>services.CoAuthoring.themes.uri</code></div></td>
|
||||
<td>Defines a path to the folder where all the <em>json</em> files with the custom color themes are stored.</td>
|
||||
<td>string</td>
|
||||
<td><code>"/web-apps/apps/common/main/resources/themes"</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>This parameter defines the properties of the custom color themes.</p>
|
||||
<h4>Example</h4>
|
||||
<pre><code>"services": {
|
||||
"CoAuthoring": {
|
||||
"themes": {
|
||||
"uri": "/web-apps/apps/common/main/resources/themes"
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 id="Editor">Editor</h2>
|
||||
<div class="block_of_step">
|
||||
<div class="screen_text">
|
||||
@ -2424,7 +2484,7 @@
|
||||
<p>This parameter is sent to the <b>npm</b> module.</p>
|
||||
</td>
|
||||
<td>string</td>
|
||||
<td><code>"10s"</code></td>
|
||||
<td><code>"2m"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="FileConverter-converter-downloadTimeout-wholeCycle"><code>FileConverter.converter.downloadTimeout.wholeCycle</code></div></td>
|
||||
@ -2474,18 +2534,6 @@
|
||||
<td>string</td>
|
||||
<td><code>"null"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="FileConverter-converter-docbuilderAllFontsPath"><code>FileConverter.converter.docbuilderAllFontsPath</code></div></td>
|
||||
<td>Defines a path to the <code>AllFonts.js</code> script which forms the font thumbnails in the editors and adds the font metrics to the <code>font_selection.bin</code> file for its further usage.</td>
|
||||
<td>string</td>
|
||||
<td><code>"null"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="FileConverter-converter-docbuilderCoreFontsPath"><code>FileConverter.converter.docbuilderCoreFontsPath</code></div></td>
|
||||
<td>Defines a path to a folder with fonts used by ONLYOFFICE Docs.</td>
|
||||
<td>string</td>
|
||||
<td><code>""</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div class="copy-link" id="FileConverter-converter-args"><code>FileConverter.converter.args</code></div></td>
|
||||
<td>Defines the additional parameters for running x2t.</td>
|
||||
@ -2554,7 +2602,7 @@
|
||||
"converter": {
|
||||
"maxDownloadBytes": 104857600,
|
||||
"downloadTimeout": {
|
||||
"connectionAndInactivity": "10s",
|
||||
"connectionAndInactivity": "2m",
|
||||
"wholeCycle": "2m"
|
||||
},
|
||||
"downloadAttemptMaxCount": 3,
|
||||
@ -2564,8 +2612,6 @@
|
||||
"presentationThemesDir": "null",
|
||||
"x2tPath": "null",
|
||||
"docbuilderPath": "null",
|
||||
"docbuilderAllFontsPath": "null",
|
||||
"docbuilderCoreFontsPath": "",
|
||||
"args": "",
|
||||
"spawnOptions": {},
|
||||
"errorfiles": "",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user