Skip to main content

Changelog

The list of changes of ONLYOFFICE Docs API.

Version 10.0​

Breaking changes​

  • The document command service, the document conversion service, and the document builder service no longer accept the token from the editor configuration. The token of these requests can contain the optional operation field (command, converter, or docbuilder), which is required for the new /converter/from-file and /docbuilder/from-file endpoints. These checks are controlled by the new services.CoAuthoring.token.purposeCheck server setting, which is validate by default. Set it to off to turn them off.
  • WOPI hosts must now be explicitly allowed by an IP filter rule. The * rule is no longer enough to open a document. Set the wopi.requireIpFilterRule server setting to false to turn off the requirement for an explicit allow rule.
  • The runtime.json file can no longer change the logging configuration except for the log levels.
  • Removed the deprecated editorConfig.customization.reviewDisplay, editorConfig.customization.showReviewChanges, and editorConfig.customization.trackChanges parameters. Use the corresponding fields of the editorConfig.customization.review parameter instead.
  • If the secret, including the secret of a tenant, is empty or not set, ONLYOFFICE Docs now rejects the token instead of verifying or signing it.

Other changes​

  • Added the interactivepreview action to the WOPI discovery. It opens a read-only preview of the document, for example in the SharePoint details pane.
  • Added opening for ofd format. Like xps, it is opened for viewing only and can be converted to other formats, but cannot be edited or saved to.
  • Added conversion to xls format from all spreadsheet formats.
  • Added the /converter/from-file and /docbuilder/from-file endpoints that take the file to convert or the script in the request itself in the multipart/form-data format instead of downloading it by URL.
  • In the commercial editions, the Admin Panel now starts automatically with the server by default. Community Edition does not include the Admin Panel.
  • The first administrator is now created with the documentserver-admin host CLI (create-admin, reset-admin-password) instead of on a web page with a bootstrap code from the logs. The administrator login is always admin.
  • Added the editorConfig.customization.ai section with the disabled parameter to turn off the AI features in the editors.
  • Added the aiSettings.enable server setting to turn off the AI features. If set to false, AI Tools is excluded from /plugins.json, and requests to /ai-proxy are rejected.
  • Form submissions saved as plain PDF are now signed as well, not only those saved as OFORM PDF.
  • The tokens are now enabled in default.json, and the default secret is the developer-only-not-a-real-secret placeholder instead of secret. Installations are not affected: they still enable the tokens and generate their own secret during installation. A warning is logged at startup while the placeholder is used.
  • The tokens of the outgoing requests to the callbackUrl address and for the file downloads now contain the operation field set to callback or download. ONLYOFFICE Docs rejects such a token if it is sent back in an incoming request.
  • Changes that were not saved before the server shut down are now recovered into forgotten files during shutdown. The standalone changes2forgotten script is removed.
  • Added the services.CoAuthoring.server.convertServiceEnable and services.CoAuthoring.server.docbuilderEnable server settings to turn off the public conversion and Document Builder APIs. Both are true by default for compatibility.
  • Added the coauth.connections StatsD metric with the mode (edit, liveview, view) and replica tags. For a sharded cluster, the total is the sum over the replicas.
  • Downloaded files are now verified against the integrity headers sent by the integrator, such as Content-Digest, Repr-Digest, x-amz-checksum-*, or the WOPI SHA256 hash. This is controlled by the services.CoAuthoring.requestDefaults.checksumVerification server setting, which is true by default.
  • The default User-Agent header of the outgoing requests is now DocumentServer instead of Node.js/6.13. It is set by the services.CoAuthoring.requestDefaults.headers.User-Agent server setting.

Version 9.4​

  • Added the plugin command logging feature for enabling debug output of plugin commands in the browser console.
  • Added the editorConfig.plugins.disable parameter to block specific plugins on load.
  • Added Croatian (hr) to the list of supported interface languages.
  • Removed the deprecated editorConfig.customization.commentAuthorOnly field.
  • Added the roles parameter to the onStartFilling event with role and user information.
  • Fixed a memory leak in the destroyEditor method that prevented full cleanup.

Version 9.1​

Version 9.0​

Version 8.3​

Version 8.2​

Version 8.1​

Version 8.0​

Version 7.5​

Version 7.4​

Version 7.3​

Version 7.2​

Version 7.1​

Version 7.0​

Version 6.4​

Version 6.3​

Version 6.2​

Version 6.1​

  • The text, spreadsheet and presentation values for documentType parameter is deprecated, please use word, cell and slide values instead.
  • Added the group field to the editorConfig.user.
  • Added the editorConfig.customization.reviewPermissions parameter.
  • Added conversion from fb2 format.
  • Removed the deprecated document.permissions.changeHistory parameter.
  • Removed the deprecated document.permissions.rename parameter.

Version 6.0​

Version 5.5​

Version 5.4​

Version 5.3​

Version 5.2​

Version 5.1​

Version 5.0​

Version 4.4​

Version 4.3​

  • Added the destroyEditor method.
  • Removed the editorConfig.plugins.url field from the plugin connection pattern.
  • Added the editorConfig.customization.commentAuthorOnly field.
  • Added the editorConfig.customization.forcesave field.
  • Added the editorConfig.customization.showReviewChanges field.
  • Added the forcesavetype field in the callback handler request when force saving the file.
  • Added the JSON format for response from document conversion service.

Version 4.2​