IlyaSobolev/helpcenter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 27 Wiki Activity

updated config docs for version 8.1

Browse Source
This commit is contained in:
Natalia Ovchinnikova 2024-04-26 15:46:35 +03:00
parent 259e8f2c54
commit 1c063dfa05
1 changed files with 345 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

366
Web/Controls/Help/Server/DeveloperEdition/ConfiguringDeveloper.ascx
View File

@ -328,6 +328,18 @@
</div>
</div>
<h2 id="PersistentStorage">Persistent storage</h2>
<div class="block_of_step">
<div class="screen_text">
<p>These parameters define the settings of the persistent storage, which is used to separate the settings for the document cache file storage and the storage of the forgotten and error files.
Settings that are not specified in this object are inherited from the <a href="#Storage">storage</a> object. The separation is convenient for server upgrades.</p>
<h4>Example</h4>
<pre><code>"persistentStorage": {
}
</code></pre>
</div>
</div>
<h2 id="RabbitMQ">RabbitMQ</h2>
<div class="block_of_step">
<div class="screen_text">
@ -748,23 +760,47 @@
<td>string</td>
<td><code>"/web-apps/apps/presentationeditor/main/resources/img/favicon.ico"</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-favIconUrlPdf"><code>wopi.favIconUrlPdf</code></div></td>
<td>Defines a path to the favicon for the pdf editor.</td>
<td>string</td>
<td><code>"/web-apps/apps/pdfeditor/main/resources/img/favicon.ico"</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-fileInfoBlockList"><code>wopi.fileInfoBlockList</code></div></td>
<td>Defines a list of WOPI file information parameters that are blocked when sending this array to the browser. However, these parameters are available on the server.</td>
<td>array of strings</td>
<td><code>["FileUrl"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-pdfView"><code>wopi.pdfView</code></div></td>
<td>Defines the file types that can be viewed in the pdf editor.</td>
<td>array of strings</td>
<td><code>["djvu", "xps", "oxps"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-pdfEdit"><code>wopi.pdfEdit</code></div></td>
<td>Defines the file types that can be edited in the pdf editor.</td>
<td>array of strings</td>
<td><code>["pdf"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-forms"><code>wopi.forms</code></div></td>
<td>Defines the form file types.</td>
<td>array of strings</td>
<td><code>["pdf"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-wordView"><code>wopi.wordView</code></div></td>
<td>Defines the file types that can be viewed in the document editor.</td>
<td>array of strings</td>
<td><code>["pdf", "djvu", "xps", "oxps", "doc", "dotx", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt"]</code></td>
<td><code>["pdf", "djvu", "xps", "oxps", "doc", "dotx", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt", "docxf", "oform"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-wordEdit"><code>wopi.wordEdit</code></div></td>
<td>Defines the file types that can be edited in the document editor.</td>
<td>array of strings</td>
<td><code>["docx", "docm", "docxf", "oform", "odt", "txt"]</code></td>
<td><code>["docx", "docm", "odt", "txt"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-cellView"><code>wopi.cellView</code></div></td>
@ -874,9 +910,13 @@
"favIconUrlWord" : "/web-apps/apps/documenteditor/main/resources/img/favicon.ico",
"favIconUrlCell" : "/web-apps/apps/spreadsheeteditor/main/resources/img/favicon.ico",
"favIconUrlSlide" : "/web-apps/apps/presentationeditor/main/resources/img/favicon.ico",
"favIconUrlPdf" : "/web-apps/apps/pdfeditor/main/resources/img/favicon.ico",
"fileInfoBlockList" : ["FileUrl"],
"wordView": ["pdf", "djvu", "xps", "oxps", "doc", "dotx", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt"],
"wordEdit": ["docx", "docm", "docxf", "oform", "odt", "txt"],
"pdfView": ["djvu", "xps", "oxps"],
"pdfEdit": ["pdf"],
"forms": ["pdf"],
"wordView": ["doc", "dotx", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt", "docxf", "oform"],
"wordEdit": ["docx", "docm", "odt", "txt"],
"cellView": ["xls", "xlsb", "xltx", "xltm", "xlt", "fods", "ots", "sxc", "xml", "et", "ett"],
"cellEdit": ["xlsx", "xlsm", "ods", "csv"],
"slideView": ["ppt", "ppsx", "ppsm", "pps", "potx", "potm", "pot", "fodp", "otp", "sxi", "dps", "dpt"],
@ -998,6 +1038,114 @@
</div>
</div>
<h2 id="ExternalRequest">External request</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<colgroup>
<col style="width: 250px;" />
<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="externalRequest-directIfIn"><code>externalRequest.directIfIn</code></div></td>
<td>Defines the IP addresses that are allowed for direct requests.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-directIfIn-allowList"><code>externalRequest.directIfIn.allowList</code></div></td>
<td>Defines a list of the IP addresses that are trusted for the direct requests.</td>
<td>list</td>
<td><code>[]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-directIfIn-jwtToken"><code>externalRequest.directIfIn.jwtToken</code></div></td>
<td>Defines if the trusted IP addresses are in the JWT or not.</td>
<td>boolean</td>
<td><code>true</code></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action"><code>externalRequest.action</code></div></td>
<td>Defines the external request options.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action-allow"><code>externalRequest.action.allow</code></div></td>
<td>Defines if the external requests are allowed or not.</td>
<td>boolean</td>
<td><code>true</code></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action-blockPrivateIP"><code>externalRequest.action.blockPrivateIP</code></div></td>
<td>Defines if the private IP address will be blocked or not.</td>
<td>boolean</td>
<td><code>true</code></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action-proxyUrl"><code>externalRequest.action.proxyUrl</code></div></td>
<td>Defines the proxy URL.</td>
<td>string</td>
<td><code>""</code></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action-proxyUser"><code>externalRequest.action.proxyUser</code></div></td>
<td>Defines the proxy authentication parameters.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action-proxyUser-username"><code>externalRequest.action.proxyUser.username</code></div></td>
<td>Defines the proxy authentication username.</td>
<td>string</td>
<td><code>""</code></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action-proxyUser-password"><code>externalRequest.action.proxyUser.password</code></div></td>
<td>Defines the proxy authentication password.</td>
<td>string</td>
<td><code>""</code></td>
</tr>
<tr>
<td><div class="copy-link" id="externalRequest-action-proxyHeaders"><code>externalRequest.action.proxyHeaders</code></div></td>
<td>Defines the proxy headers.</td>
<td>object</td>
<td><code>{}</code></td>
</tr>
</tbody>
</table>
<p>These parameters define the configuration of the external requests.</p>
<h4>Example</h4>
<pre><code>"externalRequest": {
"directIfIn" : {
"allowList": [],
"jwtToken": true
},
"action": {
"allow": true,
"blockPrivateIP": true,
"proxyUrl": "",
"proxyUser": {
"username": "",
"password": ""
},
"proxyHeaders": {
}
}
}
</code></pre>
</div>
</div>
<h2 id="Services">Document Server services</h2>
<div class="block_of_step">
<div class="screen_text">
@ -1174,9 +1322,15 @@
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-server-editorDataStorage"><code>services.CoAuthoring.server.editorDataStorage</code></div></td>
<td>Defines the editor data storage.</td>
<td>Defines the editor data storage. The possible values: <em>"editorDataMemory"</em>, <em>"editorDataRedis"</em>, <em>""</em>.</td>
<td>string</td>
<td><code>"editorDataRedis"</code></td>
<td><code>"editorDataMemory"</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-server-editorStatStorage"><code>services.CoAuthoring.server.editorStatStorage</code></div></td>
<td>Defines the editor data storage for license calculation and statistics (local memory or redis). The possible values are <em>"editorDataMemory"</em>, <em>"editorDataRedis"</em>, or <em>""</em>. The default <em>""</em> value means that the value of the <em>editorDataStorage</em> parameter will be used. This parameter is primarily used for a sharded cluster.</td>
<td>string</td>
<td><code>""</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-server-assemblyFormatAsOrigin"><code>services.CoAuthoring.server.assemblyFormatAsOrigin</code></div></td>
@ -1202,12 +1356,6 @@
<td>boolean</td>
<td><code>true</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-server-allowPrivateIPAddressForSignedRequests"><code>services.CoAuthoring.server.allowPrivateIPAddressForSignedRequests</code></div></td>
<td>Defines if the signed requests for local links are allowed or not. It is used in the multi-tenant mode for server security.</td>
<td>boolean</td>
<td><code>true</code></td>
</tr>
</tbody>
</table>
<p>These parameters define the server configuration.</p>
@ -1236,12 +1384,12 @@
"maxRequestChanges": 20000,
"openProtectedFile": true,
"isAnonymousSupport": true,
"editorDataStorage": "editorDataRedis",
"editorDataStorage": "editorDataMemory",
"editorStatStorage": "",
"assemblyFormatAsOrigin": true,
"newFileTemplate" : "../../document-templates/new",
"downloadFileAllowExt": ["pdf", "xlsx"],
"tokenRequiredParams" : true,
"allowPrivateIPAddressForSignedRequests" : true
"tokenRequiredParams" : true
}
}
}
@ -1508,7 +1656,139 @@
<td><div class="copy-link" id="services-CoAuthoring-sql-pgPoolExtraOptions"><code>services.CoAuthoring.sql.pgPoolExtraOptions</code></div></td>
<td>Defines the parameters that can be passed directly to the <a target="_blank" href="https://github.com/brianc/node-postgres-docs/blob/master/content/api/1-pool.mdx#new-poolconfig-object">node-postgres pool</a> library.</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-pgPoolExtraOptions-idleTimeoutMillis"><code>services.CoAuthoring.sql.pgPoolExtraOptions.idleTimeoutMillis</code></div></td>
<td>Defines a number of milliseconds a client must remain idle in the pool and not be checked out before it is disconnected from the backend and discarded. Set to 0 to disable automatic disconnection of idle clients.</td>
<td>integer</td>
<td><code>30000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-pgPoolExtraOptions-maxLifetimeSeconds"><code>services.CoAuthoring.sql.pgPoolExtraOptions.maxLifetimeSeconds</code></div></td>
<td>Defines a number of seconds that represents the maximum lifetime.</td>
<td>integer</td>
<td><code>60000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-pgPoolExtraOptions-statement_timeout"><code>services.CoAuthoring.sql.pgPoolExtraOptions.statement_timeout</code></div></td>
<td>Defines a number of milliseconds before the query statement times out.</td>
<td>integer</td>
<td><code>60000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-pgPoolExtraOptions-query_timeout"><code>services.CoAuthoring.sql.pgPoolExtraOptions.query_timeout</code></div></td>
<td>Defines a number of milliseconds before a query call times out.</td>
<td>integer</td>
<td><code>60000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-pgPoolExtraOptions-connectionTimeoutMillis"><code>services.CoAuthoring.sql.pgPoolExtraOptions.connectionTimeoutMillis</code></div></td>
<td>Defines a number of milliseconds to wait for a connection.</td>
<td>integer</td>
<td><code>60000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions"><code>services.CoAuthoring.sql.damengExtraOptions</code></div></td>
<td>Defines the Dameng database parameters.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-columnNameUpperCase"><code>services.CoAuthoring.sql.damengExtraOptions.columnNameUpperCase</code></div></td>
<td>Defines if the column names are uppercase or not.</td>
<td>boolean</td>
<td><code>false</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-columnNameCase"><code>services.CoAuthoring.sql.damengExtraOptions.columnNameCase</code></div></td>
<td>Defines the case of column names.</td>
<td>string</td>
<td><code>"lower"</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-connectTimeout"><code>services.CoAuthoring.sql.damengExtraOptions.connectTimeout</code></div></td>
<td>Defines a number of milliseconds to wait for a connection.</td>
<td>integer</td>
<td><code>60000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-loginEncrypt"><code>services.CoAuthoring.sql.damengExtraOptions.loginEncrypt</code></div></td>
<td>Defines if the login encryption is enabled or not.</td>
<td>boolean</td>
<td><code>false</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-localTimezone"><code>services.CoAuthoring.sql.damengExtraOptions.localTimezone</code></div></td>
<td>Defines the local timezone.</td>
<td>integer</td>
<td><code>0</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-poolTimeout"><code>services.CoAuthoring.sql.damengExtraOptions.poolTimeout</code></div></td>
<td>Defines a number of seconds after which the pool terminates idle connections (unused in the pool).</td>
<td>integer</td>
<td><code>60</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-socketTimeout"><code>services.CoAuthoring.sql.damengExtraOptions.socketTimeout</code></div></td>
<td>Defines a number of milliseconds when a connection request made by a client or a server doesn't receive a response from the other end.</td>
<td>integer</td>
<td><code>60000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-damengExtraOptions-queueTimeout"><code>services.CoAuthoring.sql.damengExtraOptions.queueTimeout</code></div></td>
<td>Defines a number of milliseconds when messages are retained in the queue before they are discarded.</td>
<td>integer</td>
<td><code>60000</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-oracleExtraOptions"><code>services.CoAuthoring.sql.oracleExtraOptions</code></div></td>
<td>Defines the Oracle database parameters.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-oracleExtraOptions-connectTimeout"><code>services.CoAuthoring.sql.oracleExtraOptions.connectTimeout</code></div></td>
<td>Defines a number of seconds to wait for a connection.</td>
<td>integer</td>
<td><code>60</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-msSqlExtraOptions"><code>services.CoAuthoring.sql.msSqlExtraOptions</code></div></td>
<td>Defines the MS SQL database parameters.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-msSqlExtraOptions-options"><code>services.CoAuthoring.sql.msSqlExtraOptions.options</code></div></td>
<td>Defines the MS SQL database options.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-msSqlExtraOptions-options-encrypt"><code>services.CoAuthoring.sql.msSqlExtraOptions.options.encrypt</code></div></td>
<td>Defines whether the data will be encrypted before sending it over the network.</td>
<td>boolean</td>
<td><code>false</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-msSqlExtraOptions-options-trustServerCertificate"><code>services.CoAuthoring.sql.msSqlExtraOptions.options.trustServerCertificate</code></div></td>
<td>Defines whether an encryption occurs when there is no verified server certificate.</td>
<td>boolean</td>
<td><code>true</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-msSqlExtraOptions-pool"><code>services.CoAuthoring.sql.msSqlExtraOptions.pool</code></div></td>
<td>Defines the parameters of the connection pool.</td>
<td>object</td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-sql-msSqlExtraOptions-pool-idleTimeoutMillis"><code>services.CoAuthoring.sql.msSqlExtraOptions.pool.idleTimeoutMillis</code></div></td>
<td>Defines a number of milliseconds a client must remain idle in the pool and not be checked out before it is disconnected from the backend and discarded. Set to 0 to disable automatic disconnection of idle clients.</td>
<td>integer</td>
<td><code>30000</code></td>
</tr>
</tbody>
</table>
@ -1528,7 +1808,35 @@
"charset": "utf8",
"connectionlimit": 10,
"max_allowed_packet": 1048575,
"pgPoolExtraOptions": {}
"pgPoolExtraOptions": {
"idleTimeoutMillis": 30000,
"maxLifetimeSeconds": 60000,
"statement_timeout": 60000,
"query_timeout": 60000,
"connectionTimeoutMillis": 60000
},
"damengExtraOptions": {
"columnNameUpperCase": false,
"columnNameCase": "lower",
"connectTimeout": 60000,
"loginEncrypt": false,
"localTimezone": 0,
"poolTimeout": 60,
"socketTimeout": 60000,
"queueTimeout": 60000
},
"oracleExtraOptions": {
"connectTimeout": 60
},
"msSqlExtraOptions": {
"options": {
"encrypt": false,
"trustServerCertificate": true
},
"pool": {
"idleTimeoutMillis": 30000
}
}
}
}
}
@ -1594,7 +1902,13 @@
<td><div class="copy-link" id="services-CoAuthoring-redis-iooptions"><code>services.CoAuthoring.redis.iooptions</code></div></td>
<td>Defines the parameters (username, password, modules etc.) that can be passed directly to the <a target="_blank" href="https://github.com/redis/ioredis/blob/main/lib/redis/RedisOptions.ts">ioredis RedisOptions</a> library.</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-iooptions-lazyConnect"><code>services.CoAuthoring.redis.iooptions.lazyConnect</code></div></td>
<td>Defines if the connection to the server will be delayed until the first command is sent or <em>redis.connect()</em> is called explicitly.</td>
<td>boolean</td>
<td><code>true</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-iooptionsClusterNodes"><code>services.CoAuthoring.redis.iooptionsClusterNodes</code></div></td>
@ -1608,7 +1922,13 @@
<td>Defines the parameters (clusterRetryStrategy, dnsLookup, scaleReads etc.) that can be passed directly to the <a target="_blank" href="https://github.com/redis/ioredis#cluster">ioredis cluster</a> library
to connect to the redis cluster. This setting has the priority over the <em>iooptions</em> parameter for connecting to the single redis.</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-iooptionsClusterOptions-lazyConnect"><code>services.CoAuthoring.redis.iooptionsClusterOptions.lazyConnect</code></div></td>
<td>Defines if the connection to the server will be delayed until the first command is sent or <em>redis.connect()</em> is called explicitly.</td>
<td>boolean</td>
<td><code>true</code></td>
</tr>
</tbody>
</table>
@ -1623,9 +1943,13 @@
"port": 6379,
"options": {},
"optionsCluster": {},
"iooptions": {},
"iooptions": {
"lazyConnect": true
},
"iooptionsClusterNodes": [],
"iooptionsClusterOptions"": {}
"iooptionsClusterOptions": {
"lazyConnect": true
}
}
}
}