Статьи с тэгом :
Закрыть
История изменений
Закрыть
Попробовать в облаке
Попробовать в облаке
Справочный центр
ONLYOFFICE Docs Developer Edition

Configuring ONLYOFFICE Docs Developer Edition

ONLYOFFICE Docs v7.1 История изменений ONLYOFFICE Docs

Version 7.1.1

Release date: 06/02/2022

Version 7.1.0

Release date: 05/12/2022

Version 7.0.1

Release date: 02/22/2022

Version 7.0.0

Release date: 01/18/2022

Version 6.4.2

Release date: 10/14/2021

Version 6.4.1

Release date: 09/28/2021

Version 6.4.0

Release date: 08/26/2021

Version 6.3.2

Release date: 08/10/2021

Version 6.3.1

Release date: 06/08/2021

Version 6.3.0

Release date: 05/20/2021

Version 6.2.2

Release date: 04/19/2021

Version 6.2.1

Release date: 03/31/2021

Version 6.2.0

Release date: 03/01/2021

Version 6.1.1

Release date: 01/28/2021

Version 6.1.0

Release date: 12/02/2020

Version 6.0.2

Release date: 11/12/2020

Version 6.0.1

Release date: 10/28/2020

Version 6.0.0

Release date: 10/14/2020

Version 5.6.5

Release date: 09/21/2020

Version 5.6.4

Release date: 09/08/2020

Version 5.6.3

Release date: 08/17/2020

Version 5.6.2

Release date: 08/07/2020

Version 5.6.1

Release date: 08/05/2020

Version 5.6.0

Release date: 07/29/2020

Version 5.5.3

Release date: 05/22/2020

Version 5.5.1

Release date: 04/09/2020

Version 5.5.0

Release date: 03/05/2020

Version 5.4.2

Release date: 11/27/2019

Version 5.4.1

Release date: 10/02/2019

Version 5.4.0

Release date: 09/03/2019

Version 5.3.4

Release date: 07/16/2019

Version 5.3.2

Release date: 06/24/2019

Version 5.3.1

Release date: 06/06/2019

Version 5.3.0

Release date: 05/28/2019

Version 5.2.8

Release date: 02/05/2019

Version 5.2.7

Release date: 01/16/2019

Version 5.2.6

Release date: 12/25/2018

Version 5.2.4

Release date: 12/12/2018

Version 5.2.3

Release date: 10/31/2018

Version 5.2.2

Release date: 10/05/2018

Version 5.2.0

Release date: 09/28/2018

Version 5.1.5

Release date: 07/18/2018

Version 5.1.4

Release date: 05/24/2018

Version 5.1.3

Release date: 04/27/2018

Version 5.1.2

Release date: 04/11/2018

Version 5.1.1

Release date: 04/05/2018

Version 5.1.0

Release date: 03/28/2018

Version 5.0.7

Release date: 01/16/2018

Version 5.0.6

Release date: 12/11/2017

Version 5.0.5

Release date: 11/28/2017

Version 5.0.4

Release date: 11/14/2017

Version 5.0.3

Release date: 11/02/2017

Version 5.0.2 только SaaS-версия

Release date: 10/13/2017

Version 5.0.1 только SaaS-версия

Release date: 10/05/2017

Version 5.0.0 только SaaS-версия

Release date: 09/23/2017

Version 4.4.4

Release date: 09/13/2017

Windows-only release

See changelog on GitHub

Version 4.4.3

Release date: 08/14/2017

Version 4.4.2

Release date: 07/24/2017

Version 4.4.1

Release date: 07/05/2017

Version 4.3.6

Release date: 06/14/2017

Version 4.3.5

Release date: 06/05/2017

Version 4.3.4

Release date: 05/16/2017

Version 4.3.3

Release date: 04/28/2017

Version 4.3.2

Release date: 04/17/2017

Version 4.3.1

Release date: 04/06/2017

Version 4.3.0

Release date: 04/03/2017

Version 4.2.11

Release date: 03/13/2017

Version 4.2.10

Release date: 02/20/2017

Version 4.2.9

Release date: 02/14/2017

Version 4.2.8

Release date: 02/06/2017

Version 4.2.7

Release date: 02/01/2017

Version 4.2.5

Release date: 01/16/2017

Version 4.2.4

Release date: 01/09/2017

Version 4.2.3

Release date: 12/23/2016

Version 4.2.2

Release date: 12/21/2016

Version 4.2.1

Release date: 12/06/2016

Version 4.2.0

Release date: 12/01/2016

Version 4.1.8

Release date: 11/03/2016

Version 4.1.7

Release date: 11/01/2016

Version 4.1.6

Release date: 10/26/2016

Version 4.1.5

Release date: 10/13/2016

Version 4.1.4

Release date: 10/07/2016

Version 4.1.3

Release date: 09/28/2016

Version 4.1.2

Release date: 09/22/2016

Version 4.0.3

Release date: 08/04/2016

Version 4.0.2

Release date: 08/03/2016

Introduction

To change any ONLYOFFICE Docs server settings, configure the corresponding parameter in ONLYOFFICE Docs configuration file, which can be found at the following path:

  • For Linux - /etc/onlyoffice/documentserver/default.json
  • For Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\default.json

If you want to change it, you can use the local.json file, where all the edited parameters should be stored. This file is located in the same directory as the default.json file and the whole object structure for the necessary parameter must be retained.

Please do not edit the contents of the default.json file directly. The default values will be restored each time you restart Docker container or upgrade ONLYOFFICE Docs to a new version and all your changes will be lost.

Default server settings are described below.

StatsD

Parameter Description Type Default
Defines if the StatsD metrics are enabled for ONLYOFFICE Docs or not. boolean false
Defines the StatsD server host (host name or IP address). string "localhost"
Defines the StatsD server port. string "8125"
Defines a string that will be added to the beginning of all the stats automatically. It helps to distinguish different applications using the same StatsD server. string "ds."

These parameters define the StatsD server properties specifying an aggregator of metrics.

Example

"statsd": {
    "useMetrics": false,
    "host": "localhost",
    "port": "8125",
    "prefix": "ds."
}

Logger

Parameter Description Type Default
Defines a path to the log file. string ""
Defines the log options. object
Defines if the log information is printed to the console or not. boolean true

These parameters define the logger properties.

Example

"log": {
    "filePath": "",
    "options": {
        "replaceConsole": true
    }
}

Queues

Parameter Description Type Default
Defines the message broker type. string "rabbitmq"
Defines the conversion timeout (measured in seconds). integer 300
Defines the TTL (time to live) of all the messages in a queue (measured in seconds). integer 900

These parameters define a queue of messages received from the message-broker.

Example

"queue": {
    "type": "rabbitmq",
    "visibilityTimeout": 300,
    "retentionPeriod": 900
}

Document storage service

Parameter Description Type Default
Defines the document storage service name. string "storage-fs"
Defines a fileSystem object parameters. object
Defines a path to the App_Data folder where all files are stored. string ""
Defines the time when the temporary URL to the fileSystem object expires (measured in seconds). integer 900
Defines the secret string which is used to sign the URL. string "verysecretstring"
Defines an AWS region where your Amazon bucket resides. string ""
Defines the S3 AWS document storage endpoint. string "http://localhost/s3"
Defines a unique S3 AWS document storage name. string "cache"
Defines the S3 AWS document storage folder name where all the files are stored. string "files"
Defines the time when the URL to the S3 AWS document storage expires (measured in milliseconds). integer 604800
Defines a key ID to access the S3 AWS document storage. string "AKID"
Defines a secret key to access the S3 AWS document storage. string "SECRET"
Defines if SSL of the S3 AWS document storage is enabled or not. boolean false
Defines if the requests to the S3 AWS document storage always use path style addressing. boolean true
Defines an external host which is used instead of the host specified in the request. string ""

These parameters define the document storage service configuration.

Example

"storage": {
    "name": "storage-fs",
    "fs": {
        "folderPath": "",
        "urlExpires": 900,
        "secretString": "verysecretstring"
    },
    "region": "",
    "endpoint": "http://localhost/s3",
    "bucketName": "cache",
    "storageFolderName": "files",
    "urlExpires": 604800,
    "accessKeyId": "AKID",
    "secretAccessKey": "SECRET",
    "sslEnabled": false,
    "s3ForcePathStyle": true,
    "externalHost": ""
}

RabbitMQ

Parameter Description Type Default
Defines the RabbitMQ URL. string "amqp://guest:guest@localhost:5672"

Defines the RabbitMQ socket options that will be passed to the socket library (net or tls). These options must be fields set on the object supplied. The socket options can be used for the SSL connection and can contain the following fields:

  • cert - defines a certificate to present to the server (in PEM or pkcs12 format),
    type: string,
    example: "";
  • key - defines the private key for the certificate (in PEM or pkcs12 format),
    type: string,
    example: "";
  • passphrase - defines a passphrase for the private key,
    type: string,
    example: "MySecretPassword";
  • ca - defines a list of the CA certificates in PEM format that we will trust, since we are using a self-signed certificate,
    type: array,
    example: [];
  • noDelay - defines if TCP_NODELAY (Nagle's algorithm) is set on the underlying socket or not,
    type: boolean,
    example: true.
object {}
Defines the Publisher Subscriber exchange server. string "ds.pubsub"
Defines a queue of tasks. string "ds.converttask"
Defines a queue of responses. string "ds.convertresponse"
Defines a dead letter exchange. string "ds.exchangeconvertdead"
Defines a dead letter queue. string "ds.convertdead"
Defines the delayed queue. string "ds.delayed"

These parameters define the RabbitMQ message broker configuration.

Example

"rabbitmq": {
    "url": "amqp://guest:guest@localhost:5672",
    "socketOptions": {},
    "exchangepubsub": "ds.pubsub",
    "queueconverttask": "ds.converttask",
    "queueconvertresponse": "ds.convertresponse",
    "exchangeconvertdead": "ds.exchangeconvertdead",
    "queueconvertdead": "ds.convertdead",
    "queuedelayed": "ds.delayed"
}

ActiveMQ

Parameter Description Type Default
Defines the ActiveMQ connect options. object
Defines a port of the server to which the ActiveMQ container is connected. integer 5672
Defines a host (host name or IP address) of the server to which the ActiveMQ container is connected. string "localhost"
Defines the user name of the ActiveMQ container. string "admin"
Defines if the ActiveMQ module will automatically attempt to reconnect if disconnected (true) or not (false). boolean false
Defines a queue of tasks. string "ds.converttask"
Defines a queue of responses. string "ds.convertresponse"
Defines a dead letter queue. string "ActiveMQ.DLQ"
Defines the delayed queue. string "ds.delayed"
Defines the Publisher Subscriber topic. string "ds.pubsub"

These parameters define the ActiveMQ message broker configuration.

Example

"activemq": {
    "connectOptions": {
        "port": 5672,
        "host": "localhost",
        "name": "admin",
        "reconnect": false
    },
    "queueconverttask": "ds.converttask",
    "queueconvertresponse": "ds.convertresponse",
    "queueconvertdead": "ActiveMQ.DLQ",
    "queuedelayed": "ds.delayed",
    "topicpubsub": "ds.pubsub"
}

DNS cache

Parameter Description Type Default
Defines if the DNS cache is enabled or not. boolean true
Defines the time when the DNS records expire (measured in seconds). integer 300
Defines the DNS cache size. integer 1000

These parameters define the configuration of the DNS cache which is used for the IP-filter.

Example

"dnscache": {
    "enable" : true,
    "ttl" : 300,
    "cachesize" : 1000
}

OpenPGP protocol

Parameter Description Type Default
Defines the OpenPGP protocol configuration. object {}
Defines the OpenPGP encryption settings. object
Defines a password which is used for the OpenPGP encryption. array of strings ["verysecretstring"]
Defines the OpenPGP decryption settings. object
Defines a password which is used for the OpenPGP decryption. array of strings ["verysecretstring"]

These parameters define the settings of the OpenPGP protocol which is used to encrypt the password when opening an encrypted document for editing.

Example

"openpgpjs": {
    "config": {
    },
    "encrypt": {
        "passwords": ["verysecretstring"]
    },
    "decrypt": {
        "passwords": ["verysecretstring"]
    }
}

WOPI

Parameter Description Type Default
Defines if WOPI is enabled or not. boolean false
Defines the WOPI host (host name or IP address). string ""
Defines a path to the WOPI HTML template. string "../../web-apps/apps/api/wopi"
Defines a zone that the Document Server uses to navigate the browser to the WOPI application. string "external-http"
Defines a path to the favicon for the document editor. string "/web-apps/apps/documenteditor/main/resources/img/favicon.ico"
Defines a path to the favicon for the spreadsheet editor. string "/web-apps/apps/spreadsheeteditor/main/resources/img/favicon.ico"
Defines a path to the favicon for the presentation editor. string "/web-apps/apps/presentationeditor/main/resources/img/favicon.ico"
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. array of strings ["FileUrl"]
Defines the file types that can be viewed in the document editor. array of strings ["pdf", "djvu", "xps", "oxps", "doc", "dotx", "dotm", "dot", "fodt", "ott", "rtf", "mht", "html", "htm", "xml", "epub", "fb2"]
Defines the file types that can be edited in the document editor. array of strings ["docx", "docm", "docxf", "oform", "odt", "txt"]
Defines the file types that can be viewed in the spreadsheet editor. array of strings ["xls", "xlsb", "xltx", "xltm", "xlt", "fods", "ots"]
Defines the file types that can be edited in the spreadsheet editor. array of strings ["xlsx", "xlsm", "ods", "csv"]
Defines the file types that can be viewed in the presentation editor. array of strings ["ppt", "ppsx", "ppsm", "pps", "potx", "potm", "pot", "fodp", "otp"]
Defines the file types that can be edited in the presentation editor. array of strings ["pptx", "pptm", "odp"]
Defines the public key that the integrator uses to check the private key. string "BgIAAACkAABSU0ExAAgAAAEAAQD/NVqekFNi8X3p6Bvdlaxm0GGuggW5kKfVEQzPGuOkGVrz6DrOMNR+k7Pq8tONY+1NHgS6Z+v3959em78qclVDuQX77Tkml0xMHAQHN4sAHF9iQJS8gOBUKSVKaHD7Z8YXch6F212YSUSc8QphpDSHWVShU7rcUeLQsd/0pkflh5+um4YKEZhm4Mou3vstp5p12NeffyK1WFZF7q4jB7jclAslYKQsP82YY3DcRwu5Tl/+W0ifVcXze0mI7v1reJ12pKn8ifRiq+0q5oJST3TRSrvmjLg9Gt3ozhVIt2HUi3La7Qh40YOAUXm0g/hUq2BepeOp1C7WSvaOFHXe6Hqq"
Defines the RSA modulus in the Base64-encoded format that is used to retrieve the public key. string "qnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/w=="
Defines the RSA exponent in the Base64-encoded format that is used to retrieve the public key. string "AQAB"
Defines the private key that signs the Document Server request. string "MIIEowIBAAKCAQEAqnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/wIDAQABAoIBAQCKtUSBs8tNYrGTQTlBHXrwpkDg+u7WSZt5sEcfnkxA39BLtlHU8gGO0E9Ihr8GAL+oWjUsEltJ9GTtN8CJ9lFdPVS8sTiCZR/YQOggmFRZTJyVzMrkXgF7Uwwiu3+KxLiTOZx9eRhfDBlTD8W9fXaegX2i2Xp2ohUhBHthEBLdaZTWFi5Sid/Y0dDzBeP6UIJorZ5D+1ybaeIVHjndpwNsIEUGUxPFLrkeiU8Rm4MJ9ahxfywcP7DjQoPGY9Ge5cBhpxfzERWf732wUD6o3+L9tvOBU00CLVjULbGZKTVE2FJMyXK9jr6Zor9Mkhomp6/8Agkr9rp+TPyelFGYEz8hAoGBAOEc09CrL3eYBkhNEcaMQzxBLvOGpg8kaDX5SaArHfl9+U9yzRqss4ARECanp9HuHfjMQo7iejao0ngDjL7BNMSaH74QlSsPOY2iOm8Qvx8/zb7g4h9r1zLjFZb3mpSA4snRZvvdiZ9ugbuVPmhXnDzRRMg45MibJeeOTJNylofRAoGBAMHfF/WutqKDoX25qZo9m74W4bttOj6oIDk1N4/c6M1Z1v/aptYSE06bkWngj9P46kqjaay4hgMtzyGruc5aojPx5MHHf5bo14+Jv4NzYtR2llrUxO+UJX7aCfUYXI7RC93GUmhpeQ414j7SNAXec58d7e+ETw+6cHiAWO4uOSTPAoGATPq5qDLR4Zi4FUNdn8LZPyKfNqHF6YmupT5hIgd8kZO1jKiaYNPL8jBjkIRmjBBcaXcYD5p85nImvumf2J9jNxPpZOpwyC/Fo5xlVROp97qu1eY7DTmodntXJ6/2SXAlnZQhHmHsrPtyG752f+HtyJJbbgiem8cKWDu+DfHybfECgYBbSLo1WiBwgN4nHqZ3E48jgA6le5azLeKOTTpuKKwNFMIhEkj//t7MYn+jhLL0Mf3PSwZU50Vidc1To1IHkbFSGBGIFHFFEzl8QnXEZS4hr/y3o/teezj0c6HAn8nlDRUzRVBEDXWMdV6kCcGpCccTIrqHzpqTY0vV0UkOTQFnDQKBgAxSEhm/gtCYJIMCBe+KBJT9uECV5xDQopTTjsGOkd4306EN2dyPOIlAfwM6K/0qWisa0Ei5i8TbRRuBeTTdLEYLqXCJ7fj5tdD1begBdSVtHQ2WHqzPJSuImTkFi9NXxd1XUyZFM3y6YQvlssSuL7QSxUIEtZHnrJTt3QDd10dj"
Defines the old public key that the integrator used to check the private key. string "BgIAAACkAABSU0ExAAgAAAEAAQD/NVqekFNi8X3p6Bvdlaxm0GGuggW5kKfVEQzPGuOkGVrz6DrOMNR+k7Pq8tONY+1NHgS6Z+v3959em78qclVDuQX77Tkml0xMHAQHN4sAHF9iQJS8gOBUKSVKaHD7Z8YXch6F212YSUSc8QphpDSHWVShU7rcUeLQsd/0pkflh5+um4YKEZhm4Mou3vstp5p12NeffyK1WFZF7q4jB7jclAslYKQsP82YY3DcRwu5Tl/+W0ifVcXze0mI7v1reJ12pKn8ifRiq+0q5oJST3TRSrvmjLg9Gt3ozhVIt2HUi3La7Qh40YOAUXm0g/hUq2BepeOp1C7WSvaOFHXe6Hqq"
Defines the old RSA modulus in the Base64-encoded format that was used to retrieve the public key. string "qnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/w=="
Defines the old RSA exponent in the Base64-encoded format that was used to retrieve the public key. string "AQAB"
Defines the old private key that signed the Document Server request. string "MIIEowIBAAKCAQEAqnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/wIDAQABAoIBAQCKtUSBs8tNYrGTQTlBHXrwpkDg+u7WSZt5sEcfnkxA39BLtlHU8gGO0E9Ihr8GAL+oWjUsEltJ9GTtN8CJ9lFdPVS8sTiCZR/YQOggmFRZTJyVzMrkXgF7Uwwiu3+KxLiTOZx9eRhfDBlTD8W9fXaegX2i2Xp2ohUhBHthEBLdaZTWFi5Sid/Y0dDzBeP6UIJorZ5D+1ybaeIVHjndpwNsIEUGUxPFLrkeiU8Rm4MJ9ahxfywcP7DjQoPGY9Ge5cBhpxfzERWf732wUD6o3+L9tvOBU00CLVjULbGZKTVE2FJMyXK9jr6Zor9Mkhomp6/8Agkr9rp+TPyelFGYEz8hAoGBAOEc09CrL3eYBkhNEcaMQzxBLvOGpg8kaDX5SaArHfl9+U9yzRqss4ARECanp9HuHfjMQo7iejao0ngDjL7BNMSaH74QlSsPOY2iOm8Qvx8/zb7g4h9r1zLjFZb3mpSA4snRZvvdiZ9ugbuVPmhXnDzRRMg45MibJeeOTJNylofRAoGBAMHfF/WutqKDoX25qZo9m74W4bttOj6oIDk1N4/c6M1Z1v/aptYSE06bkWngj9P46kqjaay4hgMtzyGruc5aojPx5MHHf5bo14+Jv4NzYtR2llrUxO+UJX7aCfUYXI7RC93GUmhpeQ414j7SNAXec58d7e+ETw+6cHiAWO4uOSTPAoGATPq5qDLR4Zi4FUNdn8LZPyKfNqHF6YmupT5hIgd8kZO1jKiaYNPL8jBjkIRmjBBcaXcYD5p85nImvumf2J9jNxPpZOpwyC/Fo5xlVROp97qu1eY7DTmodntXJ6/2SXAlnZQhHmHsrPtyG752f+HtyJJbbgiem8cKWDu+DfHybfECgYBbSLo1WiBwgN4nHqZ3E48jgA6le5azLeKOTTpuKKwNFMIhEkj//t7MYn+jhLL0Mf3PSwZU50Vidc1To1IHkbFSGBGIFHFFEzl8QnXEZS4hr/y3o/teezj0c6HAn8nlDRUzRVBEDXWMdV6kCcGpCccTIrqHzpqTY0vV0UkOTQFnDQKBgAxSEhm/gtCYJIMCBe+KBJT9uECV5xDQopTTjsGOkd4306EN2dyPOIlAfwM6K/0qWisa0Ei5i8TbRRuBeTTdLEYLqXCJ7fj5tdD1begBdSVtHQ2WHqzPJSuImTkFi9NXxd1XUyZFM3y6YQvlssSuL7QSxUIEtZHnrJTt3QDd10dj"
Defines the interval time in minutes for refreshing the lock on a file by resetting its automatic expiration timer to 30 minutes. string "10m"

These parameters define the WOPI protocol configuration.

Example

"wopi": {
    "enable": false,
    "host" : "",
    "htmlTemplate" : "../../web-apps/apps/api/wopi",
    "wopiZone" : "external-http",
    "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",
    "fileInfoBlockList" : ["FileUrl"],
    "wordView": ["pdf", "djvu", "xps", "oxps", "doc", "dotx", "dotm", "dot", "fodt", "ott", "rtf", "mht", "html", "htm", "xml", "epub", "fb2"],
    "wordEdit": ["docx", "docm", "docxf", "oform", "odt", "txt"],
    "cellView": ["xls", "xlsb", "xltx", "xltm", "xlt", "fods", "ots"],
    "cellEdit": ["xlsx", "xlsm", "ods", "csv"],
    "slideView": ["ppt", "ppsx", "ppsm", "pps", "potx", "potm", "pot", "fodp", "otp"],
    "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==",
    "exponent": "AQAB",
    "privateKey": "MIIEowIBAAKCAQEAqnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/wIDAQABAoIBAQCKtUSBs8tNYrGTQTlBHXrwpkDg+u7WSZt5sEcfnkxA39BLtlHU8gGO0E9Ihr8GAL+oWjUsEltJ9GTtN8CJ9lFdPVS8sTiCZR/YQOggmFRZTJyVzMrkXgF7Uwwiu3+KxLiTOZx9eRhfDBlTD8W9fXaegX2i2Xp2ohUhBHthEBLdaZTWFi5Sid/Y0dDzBeP6UIJorZ5D+1ybaeIVHjndpwNsIEUGUxPFLrkeiU8Rm4MJ9ahxfywcP7DjQoPGY9Ge5cBhpxfzERWf732wUD6o3+L9tvOBU00CLVjULbGZKTVE2FJMyXK9jr6Zor9Mkhomp6/8Agkr9rp+TPyelFGYEz8hAoGBAOEc09CrL3eYBkhNEcaMQzxBLvOGpg8kaDX5SaArHfl9+U9yzRqss4ARECanp9HuHfjMQo7iejao0ngDjL7BNMSaH74QlSsPOY2iOm8Qvx8/zb7g4h9r1zLjFZb3mpSA4snRZvvdiZ9ugbuVPmhXnDzRRMg45MibJeeOTJNylofRAoGBAMHfF/WutqKDoX25qZo9m74W4bttOj6oIDk1N4/c6M1Z1v/aptYSE06bkWngj9P46kqjaay4hgMtzyGruc5aojPx5MHHf5bo14+Jv4NzYtR2llrUxO+UJX7aCfUYXI7RC93GUmhpeQ414j7SNAXec58d7e+ETw+6cHiAWO4uOSTPAoGATPq5qDLR4Zi4FUNdn8LZPyKfNqHF6YmupT5hIgd8kZO1jKiaYNPL8jBjkIRmjBBcaXcYD5p85nImvumf2J9jNxPpZOpwyC/Fo5xlVROp97qu1eY7DTmodntXJ6/2SXAlnZQhHmHsrPtyG752f+HtyJJbbgiem8cKWDu+DfHybfECgYBbSLo1WiBwgN4nHqZ3E48jgA6le5azLeKOTTpuKKwNFMIhEkj//t7MYn+jhLL0Mf3PSwZU50Vidc1To1IHkbFSGBGIFHFFEzl8QnXEZS4hr/y3o/teezj0c6HAn8nlDRUzRVBEDXWMdV6kCcGpCccTIrqHzpqTY0vV0UkOTQFnDQKBgAxSEhm/gtCYJIMCBe+KBJT9uECV5xDQopTTjsGOkd4306EN2dyPOIlAfwM6K/0qWisa0Ei5i8TbRRuBeTTdLEYLqXCJ7fj5tdD1begBdSVtHQ2WHqzPJSuImTkFi9NXxd1XUyZFM3y6YQvlssSuL7QSxUIEtZHnrJTt3QDd10dj",
    "publicKeyOld": "BgIAAACkAABSU0ExAAgAAAEAAQD/NVqekFNi8X3p6Bvdlaxm0GGuggW5kKfVEQzPGuOkGVrz6DrOMNR+k7Pq8tONY+1NHgS6Z+v3959em78qclVDuQX77Tkml0xMHAQHN4sAHF9iQJS8gOBUKSVKaHD7Z8YXch6F212YSUSc8QphpDSHWVShU7rcUeLQsd/0pkflh5+um4YKEZhm4Mou3vstp5p12NeffyK1WFZF7q4jB7jclAslYKQsP82YY3DcRwu5Tl/+W0ifVcXze0mI7v1reJ12pKn8ifRiq+0q5oJST3TRSrvmjLg9Gt3ozhVIt2HUi3La7Qh40YOAUXm0g/hUq2BepeOp1C7WSvaOFHXe6Hqq",
    "modulusOld": "qnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/w==",
    "exponentOld": "AQAB",
    "privateKeyOld": "MIIEowIBAAKCAQEAqnro3nUUjvZK1i7UqeOlXmCrVPiDtHlRgIPReAjt2nKL1GG3SBXO6N0aPbiM5rtK0XRPUoLmKu2rYvSJ/Kmkdp14a/3uiEl788VVn0hb/l9OuQtH3HBjmM0/LKRgJQuU3LgHI67uRVZYtSJ/n9fYdZqnLfveLsrgZpgRCoabrp+H5Uem9N+x0OJR3LpToVRZhzSkYQrxnERJmF3bhR5yF8Zn+3BoSiUpVOCAvJRAYl8cAIs3BwQcTEyXJjnt+wW5Q1VyKr+bXp/39+tnugQeTe1jjdPy6rOTftQwzjro81oZpOMazwwR1aeQuQWCrmHQZqyV3Rvo6X3xYlOQnlo1/wIDAQABAoIBAQCKtUSBs8tNYrGTQTlBHXrwpkDg+u7WSZt5sEcfnkxA39BLtlHU8gGO0E9Ihr8GAL+oWjUsEltJ9GTtN8CJ9lFdPVS8sTiCZR/YQOggmFRZTJyVzMrkXgF7Uwwiu3+KxLiTOZx9eRhfDBlTD8W9fXaegX2i2Xp2ohUhBHthEBLdaZTWFi5Sid/Y0dDzBeP6UIJorZ5D+1ybaeIVHjndpwNsIEUGUxPFLrkeiU8Rm4MJ9ahxfywcP7DjQoPGY9Ge5cBhpxfzERWf732wUD6o3+L9tvOBU00CLVjULbGZKTVE2FJMyXK9jr6Zor9Mkhomp6/8Agkr9rp+TPyelFGYEz8hAoGBAOEc09CrL3eYBkhNEcaMQzxBLvOGpg8kaDX5SaArHfl9+U9yzRqss4ARECanp9HuHfjMQo7iejao0ngDjL7BNMSaH74QlSsPOY2iOm8Qvx8/zb7g4h9r1zLjFZb3mpSA4snRZvvdiZ9ugbuVPmhXnDzRRMg45MibJeeOTJNylofRAoGBAMHfF/WutqKDoX25qZo9m74W4bttOj6oIDk1N4/c6M1Z1v/aptYSE06bkWngj9P46kqjaay4hgMtzyGruc5aojPx5MHHf5bo14+Jv4NzYtR2llrUxO+UJX7aCfUYXI7RC93GUmhpeQ414j7SNAXec58d7e+ETw+6cHiAWO4uOSTPAoGATPq5qDLR4Zi4FUNdn8LZPyKfNqHF6YmupT5hIgd8kZO1jKiaYNPL8jBjkIRmjBBcaXcYD5p85nImvumf2J9jNxPpZOpwyC/Fo5xlVROp97qu1eY7DTmodntXJ6/2SXAlnZQhHmHsrPtyG752f+HtyJJbbgiem8cKWDu+DfHybfECgYBbSLo1WiBwgN4nHqZ3E48jgA6le5azLeKOTTpuKKwNFMIhEkj//t7MYn+jhLL0Mf3PSwZU50Vidc1To1IHkbFSGBGIFHFFEzl8QnXEZS4hr/y3o/teezj0c6HAn8nlDRUzRVBEDXWMdV6kCcGpCccTIrqHzpqTY0vV0UkOTQFnDQKBgAxSEhm/gtCYJIMCBe+KBJT9uECV5xDQopTTjsGOkd4306EN2dyPOIlAfwM6K/0qWisa0Ei5i8TbRRuBeTTdLEYLqXCJ7fj5tdD1begBdSVtHQ2WHqzPJSuImTkFi9NXxd1XUyZFM3y6YQvlssSuL7QSxUIEtZHnrJTt3QDd10dj",
    "refreshLockInterval": "10m"
}

Document Server services

These parameters define the settings for the Document Server services.

Parameter Description Type Default
Defines the settings for the co-authoring editing session. object

Server

Parameter Description Type Default
Defines the server port. integer 8000
Defines a number of worker threads per CPU. integer 1
Defines the server mode. string "development"
Defines a maximum size for all the uploaded temporary files used by each process (measured in kB). integer 104857600
Defines a maximum size for all the images uploaded in each process (measured in kB). integer 26214400
Defines the timeout properties for downloading images. object

Defines a period which specifies two timeouts:

  • read timeout - time to wait for a server to send response headers (and start the response body) before aborting the request;
  • connection timeout - sets the socket to timeout after timeout of inactivity. Note that increasing the timeout beyond the OS-wide TCP connection timeout will not have any effect.

This parameter is sent to the npm module.

string "10s"
Defines the whole request cycle - a period from the download start to the full download. string "2m"
Defines the timeout properties for callback requesting. object

Defines a period which specifies two timeouts:

  • read timeout - time to wait for a server to send response headers (and start the response body) before aborting the request;
  • connection timeout - sets the socket to timeout after timeout of inactivity. Note that increasing the timeout beyond the OS-wide TCP connection timeout will not have any effect.

This parameter is sent to the npm module.

string "10s"
Defines the whole request cycle timeout. string "2m"
Defines a path where the health check requests will be sent. string "../public/healthcheck.docx"
Defines the conversion start delay time (measured in milliseconds) after the edited file is closed. integer 5000
Defines if the singleton can be edited or not. boolean false
Defines a folder name where all the forgotten files are stored. string "forgotten"
Defines a forgotten file name. string "output"
Defines a maximum size of the request changes. integer 20000
Defines if the password-protected files can be opened or not. boolean true
Defines the editor data storage. string "editorDataRedis"
Defines if the assembled file is saved in its original format or not. boolean true
Defines a path to the "new" file template if a file of 0 bytes was received from the link for opening. string "../../document-templates/new"
Defines extensions which are allowed to be downloaded via the downloadFile handler. array of strings ["pdf"]
Defines if the required token parameters will be validated. This is required for security. For example, the conversion token will not be used to open a document. boolean true

These parameters define the server configuration.

Example

"services": {
    "CoAuthoring": {
        "server": {
            "port": 8000,
            "workerpercpu": 1,
            "mode": "development",
            "limits_tempfile_upload": 104857600,
            "limits_image_size": 26214400,
            "limits_image_download_timeout": {
                "connectionAndInactivity": "10s",
                "wholeCycle": "2m"
            },
            "callbackRequestTimeout": {
                "connectionAndInactivity": "10s",
                "wholeCycle": "2m"
            },
            "healthcheckfilepath": "../public/healthcheck.docx",
            "savetimeoutdelay": 5000,
            "edit_singleton": false,
            "forgottenfiles": "forgotten",
            "forgottenfilesname": "output",
            "maxRequestChanges": 20000,
            "openProtectedFile": true,
            "editorDataStorage": "editorDataRedis",
            "assemblyFormatAsOrigin": false,
            "newFileTemplate" : "../../document-templates/new",
            "downloadFileAllowExt": ["pdf"],
            "tokenRequiredParams" : true
        }
    }
}

Default request

Parameter Description Type Default
Defines the default HTTP request headers. object
Defines the default User-Agent request header. string "Node.js/6.13"
Defines the default Connection request header. string "Keep-Alive"
Defines if the Accept-Encoding header is added to request compressed content encodings from the server (if not already present) and decode supported content encodings in the response. boolean true
Defines if the certificates will be verified by the Document Server or not. boolean true

These parameters define the default request configuration.

Example

"services": {
    "CoAuthoring": {
        "requestDefaults": {
            "headers": {
                "User-Agent": "Node.js/6.13",
                "Connection": "Keep-Alive"
            },
            "gzip": true,
            "rejectUnauthorized": true
        }
    }
}

Auto assembly

Parameter Description Type Default
Defines if the automatic forcesaving is enabled or not. boolean false
Defines the interval time in minutes for initiating the automatic forcesaving. string "5m"
Defines the delay in minutes between the intervals. string "1m"

These parameters define the automatic forcesaving configuration.

The automatic forcesaving will only be initiated after some changes were made to the document. The empty versions will not be forcesaved automatically. Additionally, file versioning needs to be implemented on the document management system's side for this parameter to work.

Example

"services": {
    "CoAuthoring": {
        "autoAssembly": {
            "enable": false,
            "interval": "5m",
            "step": "1m"
        }
    }
}

Utils

Parameter Description Type Default
Defines a directory where all the fonts are stored. string "null"
Defines the patterns for searching font files of the corresponding extensions. string "*.ttf;*.ttc;*.otf"
Defines the supported image formats for uploading. string "jpg;jpeg;jpe;png;gif;bmp"

These parameters define the utils configuration.

Example

"services": {
    "CoAuthoring": {
        "utils": {
            "utils_common_fontdir": "null",
            "utils_fonts_search_patterns": "*.ttf;*.ttc;*.otf",
            "limits_image_types_upload": "jpg;jpeg;jpe;png;gif;bmp"
        }
    }
}

SQL

Parameter Description Type Default
Defines the database type (postgres, mariadb or mysql). string "postgres"
Defines the database table name where all the document changes are stored. string "doc_changes"
Defines the database table name where the query result is stored. string "task_result"
Defines the database server host (host name or IP address). string "localhost"
Defines the database server port. integer 5432
Defines a name of a database to be created on the image startup. string "onlyoffice"
Defines a new user name with superuser permissions for the database account. string "onlyoffice"
Defines a password set to the database account. string "onlyoffice"
Defines the database charset. string "utf8"
Defines the maximum number of the simultaneous user connections to the database server. integer 10
Defines the maximum size of data that can be sent in one request. integer 1048575
Defines the parameters that can be passed directly to the node-postgres pool library. object {}

These parameters define the database configuration.

Example

"services": {
    "CoAuthoring": {
        "sql": {
            "type": "postgres",
            "tableChanges": "doc_changes",
            "tableResult": "task_result",
            "dbHost": "localhost",
            "dbPort": 5432,
            "dbName": "onlyoffice",
            "dbUser": "onlyoffice",
            "dbPass": "onlyoffice",
            "charset": "utf8",
            "connectionlimit": 10,
            "max_allowed_packet": 1048575,
            "pgPoolExtraOptions": {}
        }
    }
}

Redis

Parameter Description Type Default
Defines the database name. string "redis"
Defines the name prefix for all the used structures in Redis. string "ds:"
Defines the Redis server host (host name or IP address). string "localhost"
Defines the Redis server port. integer 6379
Defines the parameters (username, password, modules etc.) that can be passed directly to the node-redis createClient library. object {}

These parameters define the Redis configuration.

Example

"services": {
    "CoAuthoring": {
        "redis": {
            "name": "redis",
            "prefix": "ds:",
            "host": "localhost",
            "port": 6379,
            "options": {}
        }
    }
}

PubSub service

Parameter Description Type Default
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. integer 1000

This parameter defines the PubSub service configuration.

Example

"services": {
    "CoAuthoring": {
        "pubsub": {
            "maxChanges": 1000
        }
    }
}

Expiration

Parameter Description Type Default
Defines the time for saving locks. integer 60
Defines the time of life for the user presence status. integer 300
Defines the time of life for the locks. integer 604800
Defines the time for changing indexes. integer 86400
Defines the time for locking documents. integer 30
Defines the time of life for the messages. integer 86400
Defines the time of life for the last database save executed with success. integer 604800
Defines the time of life for the forcesaving executed with success. integer 604800
Defines the time of life for the database save executed with success. integer 3600
Defines the time for starting check, during which old files are deleted from the cache (every two hours by default). string "0 */2 * * * *"
Defines the time of life for the folders in App_Data. integer 86400
Defines the time for check starting (every day at midnight by default). string "00 00 */1 * * *"
Defines the number of simultaneously deleted document folders from the cache. integer 100

Defines the inactive session lifetime. This parameter allows to end editting session for idle user. It is also used to initialize document saving procedure by terminating the last editting session. So, it defines the time after which an inactive user will be disconnected from the editing session. Its value format is "1s", "1m", "1h", "1d" etc.

Please note that by inactivity we mean the absence of any action in the editor, including cursor movement.
string "0"
Defines the lifetime for any editing session. string "30d"
Defines the time before the sessionidle or sessionabsolute ttl expires when a warning message is sent. string "2m"
Defines the time of life for the PEM files with secrets. string "1h"
Defines the time for checking the PEM files ttl. string "10m"
Defines the time when the user can open the file again after an error occurs due to opening an already saved file using the old key. string "5m"
Defines the time of life for the list of the month unique users. string "1y"

These parameters define the expiration settings.

Example

"services": {
    "CoAuthoring": {
        "expire": {
            "saveLock": 60,
            "presence": 300,
            "locks": 604800,
            "changeindex": 86400,
            "lockDoc": 30,
            "message": 86400,
            "lastsave": 604800,
            "forcesave": 604800,
            "saved": 3600,
            "documentsCron": "0 */2 * * * *",
            "files": 86400,
            "filesCron": "00 00 */1 * * *",
            "filesremovedatonce": 100,
            "sessionidle": "0",
            "sessionabsolute": "30d",
            "sessionclosecommand": "2m",
            "pemStdTTL": "1h",
            "pemCheckPeriod": "10m",
            "updateVersionStatus": "5m",
            "monthUniqueUsers": "1y"
        }
    }
}

IP filter

Parameter Description Type Default

Defines the IP filter rules that contain the following parameters:

  • address - the IP address of the integrator. This parameter can contain IP in the X.X.X.X format for ipv4 or in the xxxx.xxxx.xxxx.xxxx.xxxx.xxxx.xxxx.xxxx format for ipv6, dns-name or * wildcard to replace any symbol/symbols,
    type: string,
    example: "ip_address";
  • allowed - specifies if the IP address is trusted or not,
    type: boolean,
    example: true.
array of objects
Defines if the IP filter is used for the request or not. boolean false
Defines an error code for the IP filter. integer 403

These parameters define the IP filter configuration.

Example

"services": {
    "CoAuthoring": {
        "ipfilter": {
            "rules": [{"address": "*", "allowed": true}],
            "useforrequest": false,
            "errorcode": 403
        }
    }
}

Request Filtering Agent

Parameter Description Type Default
Defines if it is allowed to connect private IP address or not. This includes private IP addresses and reserved IP addresses. boolean true
Defines if it is allowed to connect meta IP address or not. Meta address can be 0.0.0.0 (IPv4) or :: (IPv6) - a meta address that routing another address. boolean true

These parameters define the Request Filtering Agent configuration.

Example

"services": {
    "CoAuthoring": {
        "request-filtering-agent" : {
            "allowPrivateIPAddress": true,
            "allowMetaIPAddress": true
        }
    }
}

Secret key

Parameter Description 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

Defines the parameters of a secret key to generate a token in the incoming HTTP requests with the commands from the document storage service to the document command service:

  • 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

Defines the parameters of a secret key to generate a token in the outgoing HTTP requests to the callbackUrl address by document editing service:

  • string - the secret key,
    type: string,
    example: "secret";
  • file - the PEM file where the secret is stored,
    type: string,
    example: "".
object

Defines the parameters of a secret key to generate the session token:

  • string - the secret key,
    type: string,
    example: "secret";
  • file - the PEM file where the secret is stored,
    type: string,
    example: "".
object

These parameters define the secret key configuration.

Example

"services": {
    "CoAuthoring": {
        "secret": {
            "browser": {"string": "secret", "file": "", "tenants": {}},
            "inbox": {"string": "secret", "file": "", "tenants": {}},
            "outbox": {"string": "secret", "file": ""},
            "session": {"string": "secret", "file": ""}
        }
    }
}

Token

Parameter Description Type Default
Defines if the tokens are enabled or not. object
Defines if a token in the client-side browser requests is enabled or not. boolean false
Defines if the tokens in the HTTP requests are enabled or not. object
Defines if a token in the incoming HTTP requests is enabled or not. boolean false
Defines if a token in the outgoing HTTP requests is enabled or not. 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. object
Defines the HTTP header that will be used to send the incoming request token. string "Authorization"
Defines a prefix in the HTTP header that will be used to send the incoming request token. string "Bearer "
Defines the configuration of a token from the outgoing requests. object
Defines the HTTP header that will be used to send the outgoing request token. string "Authorization"
Defines a prefix in the HTTP header that will be used to send the outgoing request token. string "Bearer "
Defines an algorithm which is used to sign the outgoing request token. string "HS256"
Defines a period when the outgoing request token expires. string "5m"
Defines the regular expression that specifies URLs from which the authorization should be excluded. The empty string means that this option is disabled. string ""
Defines the session token configuration. object
Defines an algorithm which is used to sign the session token. string "HS256"
Defines a period when the session token expires. string "30d"
Defines the token verifying options. object
Defines a number of seconds which is acceptable when dealing with the clock differences among different servers. integer 60

These parameters define the token configuration.

Example

"services": {
    "CoAuthoring": {
        "token": {
            "enable": {
                "browser": false,
                "request": {
                    "inbox": false,
                    "outbox": false
                }
            },
            "browser": {
                "secretFromInbox": true
            },
            "inbox": {
                "header": "Authorization",
                "prefix": "Bearer "
            },
            "outbox": {
                "header": "Authorization",
                "prefix": "Bearer ",
                "algorithm": "HS256",
                "expires": "5m"
                "urlExclusionRegex": ""
            },
            "session": {
                "algorithm": "HS256",
                "expires": "30d"
            },
            "verifyOptions": {
                "clockTolerance": 60
            }
        }
    }
}

Plugins

Parameter Description Type Default
Defines a path to the folder where all the plugins are stored. string "/sdkjs-plugins"
Defines a list of plugins that run automatically. list []

These parameters define the plugins configuration.

Example

"services": {
    "CoAuthoring": {
        "plugins": {
            "uri": "/sdkjs-plugins",
            "autostart": []
        }
    }
}

Editor

Parameter Description Type Default
Defines a path to the spell checker. string ""
Defines the settings for reconnecting the editor to the server. object
Defines a maximum number of attempts to reconnect the editor. integer 50
Defines the attempt delay for reconnecting the editor. string "2s"
Defines a maximum payload size of WebSocket. string "1.5MB"

These parameters define the editor configuration.

Example

"services": {
    "CoAuthoring": {
        "editor":{
            "spellcheckerUrl": "",
            "reconnection":{
                "attempts": 50,
                "delay": "2s"
            },
            "websocketMaxPayloadSize": "1.5MB"
        }
    }
}

SockJs

Parameter Description Type Default
Defines a path to the sockjs.min.js file. string ""
Defines if the WebSocket protocol is enabled or not. boolean true

These parameters define the SockJs configuration.

Example

"services": {
    "CoAuthoring": {
        "sockjs": {
            "sockjs_url": "",
            "websocket": true
        }
    }
}

Callback backoff options

Parameter Description Type Default
Defines the maximum amount of times to retry the operation. integer 0
Defines the callback backoff timeouts. object
Defines the exponential factor to use. integer 2
Defines the number of milliseconds before starting the first try. integer 1000
Defines the maximum number of milliseconds between two retries. integer 2147483647
Defines if the timeouts are randomized by multiplying with a factor between 1 to 2 or not. boolean false
Defines the HTTP statuses of the callback backoff. string "429,500-599"

These parameters define the callback backoff options.

Example

"services": {
    "CoAuthoring": {
        "callbackBackoffOptions": {
            "retries": 0,
            "timeout":{
                "factor": 2,
                "minTimeout": 1000,
                "maxTimeout": 2147483647,
                "randomize": false
            },
            "httpStatus": "429,500-599"
        }
    }
}

License

Parameter Description Type Default
Defines a path to the license file. string ""
Defines a percentage of users or connections exceeding which a license limit warning appears. integer 70

Defines the license package type: 0 - Open source, 1 - Enterprise Edition, 2 - Developer Edition.

This parameter is set at the time of version build. You do not have to manually configure it.
integer 2

These parameters define the license configuration.

Example

"license" : {
    "license_file": "",
    "warning_limit_percents": 70,
    "packageType": 2
}

Converter

Parameter Description Type Default
Defines the converter properties. object
Defines a maximum size of the file being requested (measured in bytes). integer 104857600
Defines the timeout properties for downloading the converted file. object

Defines a period which specifies two timeouts:

  • read timeout - time to wait for a server to send response headers (and start the response body) before aborting the request;
  • connection timeout - sets the socket to timeout after timeout of inactivity. Note that increasing the timeout beyond the OS-wide TCP connection timeout will not have any effect.

This parameter is sent to the npm module.

string "10s"
Defines the whole request cycle timeout. string "2m"
Defines a maximum number of attempts to download the converted file. integer 3
Defines the attempt delay to download the converted file. integer 1000
Defines a maximum number of conversion processes which can be active at one time. integer 1
Defines a path to the folder with fonts. string "null"
Defines a path to the folder with the presentation themes. string "null"
Defines a path to the x2t file converter. string "null"
Defines a path to the Document Builder application. 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. string ""
Defines the parameters that can be passed directly to the node.js child_process.spawn library (only for running x2t). object {}
Defines a path to the error files. string ""
Defines the StreamWriter buffer size. integer 8388608
Defines a maximum number of message re-deliveries. integer 2
Defines limits for input files. object
Defines the OOXML file types for which the limits are specified (text documents/spreadsheets/presentations). This does not include other objects, like images. string "docx;dotx;docm;dotm"/"xlsx;xltx;xlsm;xltm"/"pptx;ppsx;potx;pptm;ppsm;potm"
Defines the zip archive properties. object
Defines the total uncompressed file size for text documents/spreadsheets/presentations. string "50MB"/"300MB"/"50MB"
Defines the name template for files which sizes are counted. string "*.xml"

These parameters define the file converter configuration.

Example

"FileConverter": {
    "converter": {
        "maxDownloadBytes": 104857600,
        "downloadTimeout": {
            "connectionAndInactivity": "10s",
            "wholeCycle": "2m"
        },
        "downloadAttemptMaxCount": 3,
        "downloadAttemptDelay": 1000,
        "maxprocesscount": 1,
        "fontDir": "null",
        "presentationThemesDir": "null",
        "x2tPath": "null",
        "docbuilderPath": "null",
        "docbuilderAllFontsPath": "null",
        "docbuilderCoreFontsPath": "",
        "args": "",
        "spawnOptions": {},
        "errorfiles": "",
        "streamWriterBufferSize": 8388608,
        "maxRedeliveredCount": 2,
        "inputLimits": [
            {
            "type": "docx;dotx;docm;dotm",
            "zip": {
                "uncompressed": "50MB",
                "template": "*.xml"
            }
            },
            {
            "type": "xlsx;xltx;xlsm;xltm",
            "zip": {
                "uncompressed": "300MB",
                "template": "*.xml"
            }
            },
            {
            "type": "pptx;ppsx;potx;pptm;ppsm;potm",
            "zip": {
                "uncompressed": "50MB",
                "template": "*.xml"
            }
            }
        ]
    }
}
Скачать Разместите на собственном сервере Доступно для
Docker, Windows и Linux
Вас также может заинтересовать:
Закрыть