Collapse all
The below options can be edited for whitelabeling your version of ONLYOFFICE Docs, changing the information which will be displayed at the About page and visible to all editor users.
With all the above fields filled, the customization configuration will look like this:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"editorConfig": {
"customization": {
"customer": {
"address": "My City, 123a-45",
"info": "Some additional information",
"logo": "https://example.com/logo-big.png",
"logoDark": "https://example.com/dark-logo-big.png",
"mail": "john@example.com",
"name": "John Smith and Co.",
"www": "example.com"
},
"logo": {
"image": "https://example.com/logo.png",
"imageDark": "https://example.com/dark-logo.png",
"url": "https://example.com"
},
...
},
...
},
...
});
Further information about the customization can be found at this page.
If the interface language is present in the list of available ONLYOFFICE Docs languages, you can simply use the editorConfig.lang property in the configuration file to set it to the necessary locale, like this:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"editorConfig": {
"lang": "de",
...
},
...
});
If the language is not available and you want to translate it or have already translated it to your own language, please see this article to find out how to install it to your ONLYOFFICE Docs.
Further information about the language settings can be found at this page.
The chat and comments are enabled by default. To disable them use the document.permissions.comment and document.permissions.chat parameters with the values set to false in the configuration file respectively:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"document": {
"permissions": {
"chat": false,
"comment": false,
...
},
...
},
...
});
This will disable both the Chat and Comments buttons and their functionality.
Further information about the customization can be found at this page.
You can either display the full top toolbar or its compact version. To control this the editorConfig.customization.compactToolbar parameter is used. With the default false value the top toolbar will have its usual view. If you want to display its compact variant, the configuration will have to look like this:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"editorConfig": {
"customization": {
"compactToolbar": true,
...
},
...
},
...
});
Further information about the customization can be found at this page.
The document owner and uploading date is affected by the document.info.owner and document.info.uploaded parameter respectively. You can pass these settings from some database of yours to the document configuration file the following way:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"document": {
"info": {
"owner": "John Smith",
"uploaded": "2010-07-07 3:46 PM",
},
...
},
...
});
This values will be displayed in the File > Document Info... menu option.
Further information about these settings can be found at this page.
There are three main appearances of the editors, optimized for different use:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"type": "desktop",
...
});
var docEditor = new DocsAPI.DocEditor("placeholder", {
"type": "mobile",
...
});
var docEditor = new DocsAPI.DocEditor("placeholder", {
"type": "embedded",
...
});
You can use any appearance for mobile devices or to embed the document to your webpage, but it is more logical to use the specific display type.
Further information about the display type can be found at this page.
To enable plugins for all ONLYOFFICE Docs users, you need the following:
var docEditor = new DocsAPI.DocEditor("placeholder", {
"editorConfig": {
"plugins": {
"autostart": [
"asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
"asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
...
],
"pluginsData": [
"https://example.com/plugin1/config.json",
"https://example.com/plugin2/config.json",
...
]
},
...
},
...
});
Where editorConfig.plugins.autostart is the array of the GUIDs for the plugins that you want to start automatically when ONLYOFFICE Docs is started (as defined in the plugin config.json file), and editorConfig.plugins.pluginsData is the array of the config.json configuration files for all the plugins that you want to be available to ONLYOFFICE Docs users.
Further information about enabling the plugins for ONLYOFFICE Docs can be found at this page.