Compiling Document Builder

Introduction

Document Builder is a tool that allows you to generate text documents, spreadsheets, presentations, and PDF files and automate document building using templates. It can be easily integrated into your document management system using its JavaScript API.

You can easily compile Document Builder from source codes and deploy the solution on your local server using the specially designed build_tools. The build_tools allow you to automatically get and install all the components necessary for the compilation process, all the dependencies required for the Document Builder correct work, as well as to get the latest version of Document Builder source code and build all its components.

Important We can only guarantee the correct work of the products built from the master branch.

System requirements

Hardware

CPU: 4 cores
RAM: at least 8 GB. More is better
HDD: at least 100 GB SSD
SWAP: at least 4 GB, but depends on the host OS. More is better

Software

OS: Ubuntu 24.04

The solution has been tested on Ubuntu 24.04. Other distributions might require some specific actions, which are not described here.

Installing dependencies

You might need to install Python and Git if they are not yet installed on your computer. This can be done using the following command:

sudo apt-get install -y python3 git

Building Document Builder source code

Clone the build_tools repository:

git clone https://github.com/ONLYOFFICE/build_tools.git

Go to the build_tools/tools/linux directory:
```
cd build_tools/tools/linux
```
Run the automate.py script specifying the builder parameter to compile the Document Builder:
```
python3 ./automate.py builder
```
If you run the script without any parameters, this will build Document Builder alongside with ONLYOFFICE Docs and Desktop Editors.
```
python3 ./automate.py
```
If necessary, you can build several products at once by running the script with the parameters corresponding to the necessary products. To learn more about compiling ONLYOFFICE Docs, you can read this article. To learn more about compiling Desktop Editors, please refer to this article.

Wait while the script is being executed. Depending on your computer capabilities, this process may take considerable time. For example, this takes 3 hours at least on 4x2.3GHz vCPUs.

The script will compile all the dependencies and components which are a part of Document Builder.

The build will be available in the ../../out/linux_64/onlyoffice/documentbuilder/ directory. Now you can proceed to running Document Builder on your server.

Running Document Builder

Go to the ../../out/linux_64/onlyoffice/documentbuilder/ directory:

cd ../../out/linux_64/onlyoffice/documentbuilder

Execute the following command:

./docbuilder