document-server-integration/web/documentserver-example/python

Overview

This example will help you integrate ONLYOFFICE Docs into your web application written on Python.

Warning

It is intended for testing purposes and demonstrating functionality of the editors. DO NOT use this integration example on your own server without proper code modifications. In case you enabled the test example, disable it before going for production.

Installation

The Python example offers various installation options, but we highly recommend using Docker for this purpose.

Using Docker

To run the example using Docker, you will need Docker Desktop 4.17.0 or Docker Engine 20.10.23 with Docker Compose 2.15.1. Additionally, you might want to consider installing GNU Make 4.4.1, although it is optional. These are the minimum versions required for the tools.

Once you have everything installed, download the release archive and unarchive it.

$ curl --output Python.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Python.Example.zip
$ unzip Python.Example.zip

Then open the example directory and up containers.

$ cd "Python Example"
$ make compose-prod

By default, the server starts at localhost:80.

To configure the example, you can edit the environment variables in compose-base.yml. See below for more information about environment variables.

On Local Machine

Before diving into the example, you will need to install ONLYOFFICE Document Server (also known as Docs). Check the detailed guide to learn how to install it on Windows, Linux, or Docker.

To run the example on your local machine, you will need Python 3.11.4 with pip 23.1.2. Additionally, you might want to consider installing GNU Make 4.4.1, although it is optional. These are the minimum versions required for the tools.

Once you have everything installed, download the release archive and unarchive it.

$ curl --output Python.Example.zip --location https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Python.Example.zip
$ unzip Python.Example.zip

Then open the example directory, install dependencies, and start the server.

$ cd "Python Example"
$ make prod
$ make server-prod

By default, the server starts at 0.0.0.0:8000.

To configure the example, you can pass the environment variables before the command that starts the server. See below for more information about environment variables.

Post Installation

In case the example and Document Server are installed on different computers, make sure that your server with the example installed has access to the Document Server with the address which you specify instead of documentserver in the configuration files.

Make sure that the Document Server has access to the server with the example installed with the address which you specify instead of example.com in the configuration files.

Configuration

The example is configured by changing environment variables.

Name	Description	Example
DEBUG	Disable or enable debug mode.	false
ADDRESS	The address where the server should be started.	0.0.0.0
PORT	The port on which the server should be running.	80
DOCUMENT_SERVER_PRIVATE_URL	The URL through which the server will communicate with Document Server.	http://proxy:8080
DOCUMENT_SERVER_PUBLIC_URL	The URL through which a user will communicate with Document Server.	http://localhost:8080
EXAMPLE_URL	The URL through which Document Server will communicate with the server.	http://proxy
JWT_SECRET	JWT authorization secret. Leave blank to disable authorization.	your-256-bit-secret

File API methods used in this example

The methods described below are available for Python test example.

POST /upload

Summary	Upload file to test example via request
URL	/upload
Method	POST
Request Headers	Content-Type: multipart/form-data
Request Body	uploadedFile=@<filepath> filepath - file for uploading Multipart body with the file binary contents
Response	Code: 200 OK Content on success: { "filename": <filename>} Content on error: { "error": "File type is not supported" } Or { "error": "File size is incorrect" }
Sample	curl -X POST -F uploadedFile=@filename.docx http://localhost/upload

GET /remove

Summary	Delete one file
URL	/remove
Method	GET
URL Params	fileName=[string] - file for deleting.
Response	Code: 200 OK Success: { "success": true }
Sample	curl -X GET http://localhost/remove?fileName=filename.docx

DELETE /remove

Summary	Delete all files
URL	/remove
Method	DELETE
Response	Code: 200 OK Success: { "success": true }
Sample	curl -X DELETE http://localhost/remove

GET /files

Summary	Get information about all files
URL	/files
Method	GET
Response	Code: 200 OK Success: [{ "version": <file_version>, "id": <file_id>, "contentLength": <file_size_in_kilobytes>, "pureContentLength": <file_size_in_bytes>, "title": <file_name>, "updated": <last_change_date>}, ..., {...}]
Sample	curl -X GET http://localhost/files

Security Info

Please keep in mind the following security aspects when you are using test examples:

• There is no protection of the storage from unauthorized access since there is no need for authorization.
• There are no checks against parameter substitution in links, since the parameters are generated by the code according to the pre-arranged scripts.
• There are no data checks in requests of saving the file after editing, since each test example is intended for requests only from ONLYOFFICE Document Server.
• There are no prohibitions on using test examples from other sites, since they are intended to interact with ONLYOFFICE Document Server from another domain.