Frequently asked questions: Document Server

• I am new to Document Server API. Where should I start?
• I want to change some Document Server parameters from the default.json configuration file. How can I do that so that my changes were not lost after update?

Security questions

The questions concerning Document Server security issues are in this section.

• What’s the difference between sending the token in header and in body?

Sharing questions

The questions concerning document sharing with various permissions are in this section.

• How to open a document with “commenting” mode enabled?
• How to enable both the editing and commenting mode for a document?
• How to disable/enable the possibility to download the file?
• How to view and change sharing settings for a certain document?

The questions concerning inserting the document into a website page (embedding) are in this section.

• How to embed a document to a web site?

• How to check how many connections I need?
• How to disconnect users who are currently editing the document before saving the document?

Customizing questions

The questions concerning customizing the appearance of Document Server are in this section.

• How to change the default language of the Document Server interface?
• How to customize the editors interface, e.g. adjust the top toolbar view?
• How to optimize the appearance of editors for a desktop computer, or for a mobile device, or for embedding into a web page?

The questions concerning integrating Document Server with your own website and some other popular services (ownCloud, Nextcloud, SharePoint, etc.) are in this section.

• Where can I find integration examples for ONLYOFFICE Document Server?
• What settings should be used when connecting ONLYOFFICE to ownClowd/Nextcloud via a local and public network?

Editing questions

The questions concerning editing documents using Document Server are in this section.

• What is the ‘document.key’ parameter?

• How to display a document with highlighted changes?

The questions concerning saving the documents are in this section.

• How to forcefully save the document to my storage when editing it?
• How to save the opened document to another document file type?
• What is the conversion start delay time and how can it be changed?

The questions concerning renaming the documents are in this section.

• How to rename the created document?

The questions concerning using WOPI are in this section.

• How to enable WOPI?
• Why do I need the discovery XML and how can I get it?
• How to create an online office session within the application?
• Where can I find possible WOPI error codes and their descriptions?
• How to restrict access to the use of ONLYOFFICE server via WOPI?
• What actions are supported via WOPI?