Merge pull request #55 from ONLYOFFICE/feature/config-docs-7.5

Config 7.5
This commit is contained in:
Svetlana Maleeva 2023-09-11 11:09:12 +03:00 committed by GitHub
commit b8b4273bf6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -906,6 +906,13 @@
<td>string</td> <td>string</td>
<td><code>""</code></td> <td><code>""</code></td>
</tr> </tr>
<tr>
<td><div class="copy-link" id="tenants-filenameConfig"><code>tenants.filenameConfig</code></div></td>
<td>Defines the name of the config file in the tenant folder to override <em>default.json</em>. It is used in the multi-tenant mode
to initialize the specific tenant settings (wopi, ipfilter, jwt secret etc.).</td>
<td>string</td>
<td><code>"config.json"</code></td>
</tr>
<tr> <tr>
<td><div class="copy-link" id="tenants-filenameSecret"><code>tenants.filenameSecret</code></div></td> <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>Defines the <em>.pem</em> filename where the tenant secret key is stored.</td>
@ -955,6 +962,7 @@
<pre><code>"tenants": { <pre><code>"tenants": {
"baseDir" : "", "baseDir" : "",
"baseDomain" : "", "baseDomain" : "",
"filenameConfig" : "config.json",
"filenameSecret" : "secret.key", "filenameSecret" : "secret.key",
"filenameLicense" : "license.lic", "filenameLicense" : "license.lic",
"defaultTenant" : "localhost", "defaultTenant" : "localhost",
@ -1172,6 +1180,12 @@
<td>boolean</td> <td>boolean</td>
<td><code>true</code></td> <td><code>true</code></td>
</tr> </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> </tbody>
</table> </table>
<p>These parameters define the server configuration.</p> <p>These parameters define the server configuration.</p>
@ -1204,7 +1218,8 @@
"assemblyFormatAsOrigin": true, "assemblyFormatAsOrigin": true,
"newFileTemplate" : "../../document-templates/new", "newFileTemplate" : "../../document-templates/new",
"downloadFileAllowExt": ["pdf", "xlsx"], "downloadFileAllowExt": ["pdf", "xlsx"],
"tokenRequiredParams" : true "tokenRequiredParams" : true,
"allowPrivateIPAddressForSignedRequests" : true
} }
} }
} }
@ -1340,7 +1355,7 @@
<col style="width: 250px;" /> <col style="width: 250px;" />
<col /> <col />
<col style="width: 150px;" /> <col style="width: 150px;" />
<col style="width: 250px;" /> <col style="width: 300px;" />
</colgroup> </colgroup>
<tbody> <tbody>
<tr> <tr>
@ -1365,7 +1380,7 @@
<td><div class="copy-link" id="services-CoAuthoring-utils-limits_image_types_upload"><code>services.CoAuthoring.utils.limits_image_types_upload</code></div></td> <td><div class="copy-link" id="services-CoAuthoring-utils-limits_image_types_upload"><code>services.CoAuthoring.utils.limits_image_types_upload</code></div></td>
<td>Defines the supported image formats for uploading.</td> <td>Defines the supported image formats for uploading.</td>
<td>string</td> <td>string</td>
<td><code>"jpg;jpeg;jpe;png;gif;bmp"</code></td> <td><code>"jpg;jpeg;jpe;png;gif;bmp;svg"</code></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -1376,7 +1391,7 @@
"utils": { "utils": {
"utils_common_fontdir": "null", "utils_common_fontdir": "null",
"utils_fonts_search_patterns": "*.ttf;*.ttc;*.otf", "utils_fonts_search_patterns": "*.ttf;*.ttc;*.otf",
"limits_image_types_upload": "jpg;jpeg;jpe;png;gif;bmp" "limits_image_types_upload": "jpg;jpeg;jpe;png;gif;bmp;svg"
} }
} }
} }
@ -1532,7 +1547,7 @@
<td><div class="copy-link" id="services-CoAuthoring-redis-host"><code>services.CoAuthoring.redis.host</code></div></td> <td><div class="copy-link" id="services-CoAuthoring-redis-host"><code>services.CoAuthoring.redis.host</code></div></td>
<td>Defines the Redis server host (host name or IP address).</td> <td>Defines the Redis server host (host name or IP address).</td>
<td>string</td> <td>string</td>
<td><code>"localhost"</code></td> <td><code>"127.0.0.1"</code></td>
</tr> </tr>
<tr> <tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-port"><code>services.CoAuthoring.redis.port</code></div></td> <td><div class="copy-link" id="services-CoAuthoring-redis-port"><code>services.CoAuthoring.redis.port</code></div></td>
@ -1546,9 +1561,30 @@
<td>object</td> <td>object</td>
<td><code>{}</code></td> <td><code>{}</code></td>
</tr> </tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-optionsCluster"><code>services.CoAuthoring.redis.optionsCluster</code></div></td>
<td>Defines the parameters (rootNodes, defaults, modules etc.) that can be passed directly to the <a target="_blank" href="https://github.com/redis/node-redis/blob/master/docs/clustering.md">node-redis clustering</a>
library to connect to the redis cluster. This setting has the priority over the <em>options</em> parameter for connecting to the single redis.</td>
<td>object</td>
<td><code>{}</code></td>
</tr>
<tr> <tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-iooptions"><code>services.CoAuthoring.redis.iooptions</code></div></td> <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>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>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-iooptionsClusterNodes"><code>services.CoAuthoring.redis.iooptionsClusterNodes</code></div></td>
<td>Defines a list of nodes of the cluster you want to connect to 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>array</td>
<td><code>[]</code></td>
</tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-redis-iooptionsClusterOptions"><code>services.CoAuthoring.redis.iooptionsClusterOptions</code></div></td>
<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>object</td>
<td><code>{}</code></td> <td><code>{}</code></td>
</tr> </tr>
@ -1561,10 +1597,13 @@
"redis": { "redis": {
"name": "redis", "name": "redis",
"prefix": "ds:", "prefix": "ds:",
"host": "localhost", "host": "127.0.0.1",
"port": 6379, "port": 6379,
"options": {}, "options": {},
"iooptions": {} "optionsCluster": {},
"iooptions": {},
"iooptionsClusterNodes": [],
"iooptionsClusterOptions"": {}
} }
} }
} }
@ -1675,6 +1714,12 @@
<td>integer</td> <td>integer</td>
<td><code>604800</code></td> <td><code>604800</code></td>
</tr> </tr>
<tr>
<td><div class="copy-link" id="services-CoAuthoring-expire-forcesaveLock"><code>services.CoAuthoring.expire.forcesaveLock</code></div></td>
<td>Defines the time of life for the forcesaved locks in the ioredis cluster mode.</td>
<td>integer</td>
<td><code>5000</code></td>
</tr>
<tr> <tr>
<td><div class="copy-link" id="services-CoAuthoring-expire-saved"><code>services.CoAuthoring.expire.saved</code></div></td> <td><div class="copy-link" id="services-CoAuthoring-expire-saved"><code>services.CoAuthoring.expire.saved</code></div></td>
<td>Defines the time of life for the database save executed with success.</td> <td>Defines the time of life for the database save executed with success.</td>
@ -1765,6 +1810,7 @@
"message": 86400, "message": 86400,
"lastsave": 604800, "lastsave": 604800,
"forcesave": 604800, "forcesave": 604800,
"forcesaveLock": 5000,
"saved": 3600, "saved": 3600,
"documentsCron": "0 */2 * * * *", "documentsCron": "0 */2 * * * *",
"files": 86400, "files": 86400,