updated config docs for version 7.4

This commit is contained in:
Natalia Ovchinnikova 2023-05-26 18:21:56 +03:00
parent 10bc802219
commit e24d9ac978

View File

@ -485,12 +485,6 @@
<td>string</td>
<td><code>"localhost"</code></td>
</tr>
<tr>
<td><div class="copy-link" id="activemq-connectOptions-name"><code>activemq.connectOptions.name</code></div></td>
<td>Defines the user name of the ActiveMQ container.</td>
<td>string</td>
<td><code>"admin"</code></td>
</tr>
<tr>
<td><div class="copy-link" id="activemq-connectOptions-reconnect"><code>activemq.connectOptions.reconnect</code></div></td>
<td>Defines if the ActiveMQ module will automatically attempt to reconnect if disconnected (<b>true</b>) or not (<b>false</b>).</td>
@ -535,7 +529,6 @@
"connectOptions": {
"port": 5672,
"host": "localhost",
"name": "admin",
"reconnect": false
},
"queueconverttask": "ds.converttask",
@ -765,7 +758,7 @@
<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", "html", "htm", "xml", "epub", "fb2"]</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"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-wordEdit"><code>wopi.wordEdit</code></div></td>
@ -777,7 +770,7 @@
<td><div class="copy-link" id="wopi-cellView"><code>wopi.cellView</code></div></td>
<td>Defines the file types that can be viewed in the spreadsheet editor.</td>
<td>array of strings</td>
<td><code>["xls", "xlsb", "xltx", "xltm", "xlt", "fods", "ots"]</code></td>
<td><code>["xls", "xlsb", "xltx", "xltm", "xlt", "fods", "ots", "sxc", "xml", "et", "ett"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-cellEdit"><code>wopi.cellEdit</code></div></td>
@ -789,7 +782,7 @@
<td><div class="copy-link" id="wopi-slideView"><code>wopi.slideView</code></div></td>
<td>Defines the file types that can be viewed in the presentation editor.</td>
<td>array of strings</td>
<td><code>["ppt", "ppsx", "ppsm", "pps", "potx", "potm", "pot", "fodp", "otp"]</code></td>
<td><code>["ppt", "ppsx", "ppsm", "pps", "potx", "potm", "pot", "fodp", "otp", "sxi", "dps", "dpt"]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="wopi-slideEdit"><code>wopi.slideEdit</code></div></td>
@ -864,11 +857,11 @@
"favIconUrlCell" : "/web-apps/apps/spreadsheeteditor/main/resources/img/favicon.ico",
"favIconUrlSlide" : "/web-apps/apps/presentationeditor/main/resources/img/favicon.ico",
"fileInfoBlockList" : ["FileUrl"],
"wordView": ["pdf", "djvu", "xps", "oxps", "doc", "dotx", "dotm", "dot", "fodt", "ott", "rtf", "mht", "html", "htm", "xml", "epub", "fb2"],
"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"],
"cellView": ["xls", "xlsb", "xltx", "xltm", "xlt", "fods", "ots"],
"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"],
"slideView": ["ppt", "ppsx", "ppsm", "pps", "potx", "potm", "pot", "fodp", "otp", "sxi", "dps", "dpt"],
"slideEdit": ["pptx", "pptm", "odp"],
"publicKey": "BgIAAACkAABSU0ExAAgAAAEAAQD/NVqekFNi8X3p6Bvdlaxm0GGuggW5kKfVEQzPGuOkGVrz6DrOMNR+k7Pq8tONY+1NHgS6Z+v3959em78qclVDuQX77Tkml0xMHAQHN4sAHF9iQJS8gOBUKSVKaHD7Z8YXch6F212YSUSc8QphpDSHWVShU7rcUeLQsd/0pkflh5+um4YKEZhm4Mou3vstp5p12NeffyK1WFZF7q4jB7jclAslYKQsP82YY3DcRwu5Tl/+W0ifVcXze0mI7v1reJ12pKn8ifRiq+0q5oJST3TRSrvmjLg9Gt3ozhVIt2HUi3La7Qh40YOAUXm0g/hUq2BepeOp1C7WSvaOFHXe6Hqq",
"modulus": "qnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/w==",
@ -1143,6 +1136,12 @@
<td>boolean</td>
<td><code>true</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-server-isAnonymousSupport"><code>services.CoAuthoring.server.isAnonymousSupport</code></div></td>
<td>Defines if the anonymous users have access to the editor or live viewer or not.</td>
<td>boolean</td>
<td><code>true</code></td>
</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>
@ -1200,6 +1199,7 @@
"forgottenfilesname": "output",
"maxRequestChanges": 20000,
"openProtectedFile": true,
"isAnonymousSupport": true,
"editorDataStorage": "editorDataRedis",
"assemblyFormatAsOrigin": true,
"newFileTemplate" : "../../document-templates/new",
@ -1546,6 +1546,12 @@
<td>object</td>
<td><code>{}</code></td>
</tr>
<tr>
<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://luin.github.io/ioredis/index.html#RedisOptions">RedisOptions</a> library.</td>
<td>object</td>
<td><code>{}</code></td>
</tr>
</tbody>
</table>
<p>These parameters define the Redis configuration.</p>
@ -1557,7 +1563,8 @@
"prefix": "ds:",
"host": "localhost",
"port": 6379,
"options": {}
"options": {},
"iooptions": {}
}
}
}
@ -1586,7 +1593,7 @@
<td><div class="copy-link" id="services-CoAuthoring-pubsub-maxChanges"><code>services.CoAuthoring.pubsub.maxChanges</code></div></td>
<td>Defines the maximum size of changes which can be passed via PubSub. If the size exceeds the specified value, the changes will be read from the database.</td>
<td>integer</td>
<td><code>0</code></td>
<td><code>1000</code></td>
</tr>
</tbody>
</table>
@ -1595,7 +1602,7 @@
<pre><code>"services": {
"CoAuthoring": {
"pubsub": {
"maxChanges": 0
"maxChanges": 1000
}
}
}
@ -1868,13 +1875,13 @@
<td><div class="copy-link" id="services-CoAuthoring-request-filtering-agent-allowPrivateIPAddress"><code>services.CoAuthoring.request-filtering-agent.allowPrivateIPAddress</code></div></td>
<td>Defines if it is allowed to connect private IP address or not. This includes private IP addresses and reserved IP addresses.</td>
<td>boolean</td>
<td><code>true</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-request-filtering-agent-allowMetaIPAddress"><code>services.CoAuthoring.request-filtering-agent.allowMetaIPAddress</code></div></td>
<td>Defines if it is allowed to connect meta IP address or not. Meta address can be <code>0.0.0.0</code> (IPv4) or <code>::</code> (IPv6) - a meta address that routing another address.</td>
<td>boolean</td>
<td><code>true</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>
@ -1883,8 +1890,8 @@
<pre><code>"services": {
"CoAuthoring": {
"request-filtering-agent" : {
"allowPrivateIPAddress": true,
"allowMetaIPAddress": true
"allowPrivateIPAddress": false,
"allowMetaIPAddress": false
}
}
}
@ -1909,6 +1916,30 @@
<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>
</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>
@ -1988,6 +2019,7 @@
<pre><code>"services": {
"CoAuthoring": {
"secret": {
"browser": {"string": "secret", "file": ""},
"inbox": {"string": "secret", "file": ""},
"outbox": {"string": "secret", "file": ""},
"session": {"string": "secret", "file": ""}
@ -2045,6 +2077,18 @@
<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>
@ -2155,6 +2199,9 @@
"outbox": false
}
},
"browser": {
"secretFromInbox": true
},
"inbox": {
"header": "Authorization",
"prefix": "Bearer ",