Parameter |
Description |
Type |
Default |
wopi.enable
|
Defines if WOPI is enabled or not. |
boolean |
false |
wopi.host
|
Defines the WOPI host (host name or IP address). |
string |
"" |
wopi.htmlTemplate
|
Defines a path to the WOPI HTML template. |
string |
"../../web-apps/apps/api/wopi" |
wopi.wopiZone
|
Defines a zone that the Document Server uses to navigate the browser to the WOPI application. |
string |
"external-http" |
wopi.favIconUrlWord
|
Defines a path to the favicon for the document editor. |
string |
"/web-apps/apps/documenteditor/main/resources/img/favicon.ico" |
wopi.favIconUrlCell
|
Defines a path to the favicon for the spreadsheet editor. |
string |
"/web-apps/apps/spreadsheeteditor/main/resources/img/favicon.ico" |
wopi.favIconUrlSlide
|
Defines a path to the favicon for the presentation editor. |
string |
"/web-apps/apps/presentationeditor/main/resources/img/favicon.ico" |
wopi.favIconUrlPdf
|
Defines a path to the favicon for the pdf editor. |
string |
"/web-apps/apps/pdfeditor/main/resources/img/favicon.ico" |
wopi.fileInfoBlockList
|
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"] |
wopi.pdfView
|
Defines the file types that can be viewed in the pdf editor. |
array of strings |
["djvu", "xps", "oxps"] |
wopi.pdfEdit
|
Defines the file types that can be edited in the pdf editor. |
array of strings |
["pdf"] |
wopi.forms
|
Defines the form file types. |
array of strings |
["pdf"] |
wopi.wordView
|
Defines the file types that can be viewed in the document editor. |
array of strings |
["doc", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt", "pages", "docxf", "oform"] |
wopi.wordEdit
|
Defines the file types that can be edited in the document editor. |
array of strings |
["docx", "dotx", "docm", "odt", "txt"] |
wopi.cellView
|
Defines the file types that can be viewed in the spreadsheet editor. |
array of strings |
["xls", "xlsb", "xltm", "xlt", "fods", "ots", "sxc", "xml", "et", "ett", "numbers"] |
wopi.cellEdit
|
Defines the file types that can be edited in the spreadsheet editor. |
array of strings |
["xlsx", "xltx", "xlsm", "ods", "csv"] |
wopi.slideView
|
Defines the file types that can be viewed in the presentation editor. |
array of strings |
["ppt", "ppsx", "ppsm", "pps", "potm", "pot", "fodp", "otp", "sxi", "dps", "dpt", "key"] |
wopi.slideEdit
|
Defines the file types that can be edited in the presentation editor. |
array of strings |
["pptx", "potx", "pptm", "odp"] |
wopi.publicKey
|
Defines the public key that the integrator uses to check the private key.
Please note that starting from version 8.3, the values of this parameter in the default.json and local.json files are different.
|
string |
"" |
wopi.modulus
|
Defines the RSA modulus in the Base64-encoded format that is used to retrieve the public key.
Please note that starting from version 8.3, the values of this parameter in the default.json and local.json files are different.
|
string |
"" |
wopi.exponent
|
Defines the RSA exponent in the Base64-encoded format that is used to retrieve the public key. |
string |
65537 |
wopi.privateKey
|
Defines the private key that signs the Document Server request.
Please note that starting from version 8.3, the values of this parameter in the default.json and local.json files are different.
|
string |
"" |
wopi.publicKeyOld
|
Defines the old public key that the integrator used to check the private key.
Please note that starting from version 8.3, the values of this parameter in the default.json and local.json files are different.
|
string |
"" |
wopi.modulusOld
|
Defines the old RSA modulus in the Base64-encoded format that was used to retrieve the public key.
Please note that starting from version 8.3, the values of this parameter in the default.json and local.json files are different.
|
string |
"" |
wopi.exponentOld
|
Defines the old RSA exponent in the Base64-encoded format that was used to retrieve the public key. |
string |
65537 |
wopi.privateKeyOld
|
Defines the old private key that signed the Document Server request.
Please note that starting from version 8.3, the values of this parameter in the default.json and local.json files are different.
|
string |
"" |
wopi.refreshLockInterval
|
Defines the interval time in minutes for refreshing the lock on a file by resetting its automatic expiration timer to 30 minutes. |
string |
"10m" |
wopi.dummy
|
Defines the properties of dummy handlers for stress testing. |
object |
|
wopi.dummy.enable
|
Defines if the dummy handlers are enabled or not. |
boolean |
false |
wopi.dummy.sampleFilePath
|
Defines the dummy path to the sample file. |
string |
"" |
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",
"favIconUrlPdf" : "/web-apps/apps/pdfeditor/main/resources/img/favicon.ico",
"fileInfoBlockList" : ["FileUrl"],
"pdfView": ["djvu", "xps", "oxps"],
"pdfEdit": ["pdf"],
"forms": ["pdf"],
"wordView": ["doc", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt", "pages", "docxf", "oform"],
"wordEdit": ["docx", "dotx", "docm", "odt", "txt"],
"cellView": ["xls", "xlsb", "xltm", "xlt", "fods", "ots", "sxc", "xml", "et", "ett", "numbers"],
"cellEdit": ["xlsx", "xltx", "xlsm", "ods", "csv"],
"slideView": ["ppt", "ppsx", "ppsm", "pps", "potm", "pot", "fodp", "otp", "sxi", "dps", "dpt", "key"],
"slideEdit": ["pptx", "potx", "pptm", "odp"],
"publicKey": "",
"modulus": "",
"exponent": 65537,
"privateKey": "",
"publicKeyOld": "",
"modulusOld": "",
"exponentOld": 65537,
"privateKeyOld": "",
"refreshLockInterval": "10m",
"dummy": {
"enable": false,
"sampleFilePath": ""
}
}