Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use "editor.import.api", "editor.upload.image.api", "editor.upload.video.api", "editor.upload.file.api" keys to configure upload / import APIs.
Server API addresses (URL) should correspond to those of back-end implementation details. Please refer to Integration page for further information.

Configuration Method

KeyDescriptions
editor.import.maxSize

Set the maximum importable file size. (unit - byte, default - 10MB)

This value is set by the browser (client) and the maximum importable file size may vary depending on the server configuration.

editor.import.api

Set import API (URL). Document files will be sent to the designated API (URL).

editor.import.param

Set the parameter to be sent with the import request.

editor.import.headers

Status
colourYellow
titleRELEASE 2.7.0 OR ABOVE
 Set the header to be sent with the import request.

editor.upload.maxSize

Set the maximum uploadable file size. (unit - byte, default - 3MB)

This value is set by the browser (client) and the maximum uploadable file size may vary depending on the server configuration.

editor.upload.image.api

Set image upload API (URL). Images will be sent to the designated API (URL).

editor.upload.image.param

Set the parameter to be sent with the image upload request.

editor.upload.image.headers

Status
colourYellow
titleRELEASE 2.7.0 OR ABOVE
 Set the header to be sent with the image upload request.

editor.upload.video.api

Set video upload API (URL). Videos will be sent to the designated API (URL).

editor.upload.video.param

Set the parameter to be sent with the video upload request.

editor.upload.video.headers

Status
colourYellow
titleRELEASE 2.7.0 OR ABOVE
 Set the header to be sent with the video upload request.

editor.upload.file.api

Set file upload API (URL). Files will be sent to the designated API (URL).

editor.upload.file.param

Set the parameter to be sent with the file upload request.

editor.upload.file.headers

Status
colourYellow
titleRELEASE 2.7.0 OR ABOVE
 Set the header to be sent with the file upload request.

Configuration Example

Code Block
languagejs
themeEmacs
titlesynapeditor.config.js
{  
	'editor.import.maxSize': 10485760,
	'editor.import.api': '/importDoc',
	'editor.import.param': {},
	'editor.upload.maxSize': 3145728,
	'editor.upload.image.api': '/uploadImage',
	'editor.upload.image.param': {},
	'editor.upload.video.api': '/uploadVideo',
	'editor.upload.video.param': {},
	'editor.upload.file.api': '/uploadFile',
	'editor.upload.file.param': {},
}



See also