From 1cf0acf960aeca3cb11d355de526f1eee335b0cc Mon Sep 17 00:00:00 2001 From: Natalia Date: Tue, 9 Aug 2022 10:31:23 +0300 Subject: [PATCH] updated docs config for v7.2 --- .../ConfiguringDeveloper.ascx | 212 +++++++++++------- 1 file changed, 129 insertions(+), 83 deletions(-) diff --git a/Web/Controls/Help/Server/DeveloperEdition/ConfiguringDeveloper.ascx b/Web/Controls/Help/Server/DeveloperEdition/ConfiguringDeveloper.ascx index 060c16e91..1b7314a5d 100644 --- a/Web/Controls/Help/Server/DeveloperEdition/ConfiguringDeveloper.ascx +++ b/Web/Controls/Help/Server/DeveloperEdition/ConfiguringDeveloper.ascx @@ -842,6 +842,68 @@ +

Tenants

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescriptionTypeDefault
Defines a directory that limits the files that can be accessed by ONLYOFFICE Docs.string""
Defines the tenant base domain name.string""
Defines the .pem filename where the tenant secret key is stored.string"secret.key"
Defines the filename where the tenant license is stored.string"license.lic"
Defines the domain name of the default tenant.string"localhost"
+

These parameters define the tenants properties.

+

Example

+
"tenants": {
+    "baseDir" : "",
+    "baseDomain" : "",
+    "filenameSecret" : "secret.key",
+    "filenameLicense" : "license.lic",
+    "defaultTenant" : "localhost"
+}
+
+
+
+

Document Server services

@@ -935,7 +997,7 @@

This parameter is sent to the npm module.

string - "10s" + "2m" @@ -960,13 +1022,13 @@

This parameter is sent to the npm module.

string - "10s" + "10m" Defines the whole request cycle timeout. string - "2m" + "10m" @@ -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 @@
Please note that by inactivity we mean the absence of any action in the editor, including cursor movement.
string - "0" + "1h" @@ -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 @@ Type Default - - - -

Defines the parameters of a secret key to generate a token in the client-side browser requests to ONLYOFFICE Docs:

-
    -
  • - string - the secret key, -
    - type: string, -
    - example: "secret"; -
  • -
  • - file - the PEM file where the secret is stored, -
    - type: string, -
    - example: ""; -
  • -
  • - tenants - a collection of tenants with their issuers, -
    - type: object, -
    - example: {}. -
  • -
- - object - - @@ -1824,14 +1855,7 @@
type: string,
- example: ""; - -
  • - tenants - a collection of tenants with their issuers, -
    - type: object, -
    - example: {}. + example: "".
  • @@ -1893,8 +1917,7 @@
    "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 @@
                             boolean
                             false
                         
    -                    
    -                        
    -                        Defines the browser token configuration.
    -                        object
    -                        
    -                    
    -                    
    -                        
    -                        Defines if the browser token is equal to the token from the incoming requests (true) or not (false).
    -                        boolean
    -                        true
    -                    
                         
                             
                             Defines the configuration of a token from the incoming requests.
    @@ -1981,6 +1992,12 @@
                             string
                             "Bearer "
                         
    +                    
    +                        
    +                        Defines if a token is enabled in the incoming request body or not.
    +                        boolean
    +                        false
    +                    
                         
                             
                             Defines the configuration of a token from the outgoing requests.
    @@ -2011,6 +2028,12 @@
                             string
                             "5m"
                         
    +                    
    +                        
    +                        Defines if a token is enabled in the outgoing request body or not.
    +                        boolean
    +                        false
    +                    
                         
                             
                             Defines the regular expression that specifies URLs from which the authorization should be excluded. The empty string means that this option is disabled.
    @@ -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 @@
             
    +

    Themes

    +
    +
    + + + + + + + + + + + + + + + + + + + + + +
    ParameterDescriptionTypeDefault
    Defines a path to the folder where all the json files with the custom color themes are stored.string"/web-apps/apps/common/main/resources/themes"
    +

    This parameter defines the properties of the custom color themes.

    +

    Example

    +
    "services": {
    +    "CoAuthoring": {
    +        "themes": {
    +            "uri": "/web-apps/apps/common/main/resources/themes"
    +        }
    +    }
    +}
    +
    +
    +
    +

    Editor

    @@ -2424,7 +2484,7 @@

    This parameter is sent to the npm module.

    string - "10s" + "2m" @@ -2474,18 +2534,6 @@ string "null" - - - Defines a path to the AllFonts.js script which forms the font thumbnails in the editors and adds the font metrics to the font_selection.bin file for its further usage. - string - "null" - - - - Defines a path to a folder with fonts used by ONLYOFFICE Docs. - string - "" - Defines the additional parameters for running x2t. @@ -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": "",