Installing Document Builder

ONLYOFFICE Document Builder can be installed on various platforms to generate, edit, and convert Office and PDF documents.

注意

The free version of ONLYOFFICE Document Builder includes a watermark on all generated documents. To remove this limitation and access the full feature set, a commercial license is required.

For purchasing details, please contact us at sales@onlyoffice.com.

Prerequisites

Python

• Python 3.10 - 3.12
• pip3. Make sure python3 and pip3 are installed in your system. You can check your Python version and pip3 version by using the command in the terminal:

python3 --version
python3 -m pip --version

备注

Use pip and python for Windows. Make sure the executable name is python.exe (default on Windows) and Python is added to your path environment variable.

If you need to install them, you can use the following commands:

sudo apt install python3 python3-pip

信息

You can install python3 and pip3 for macOS with Homebrew using the following command:

brew install python3

C++

• Visual Studio for Windows
• GCC ≥ 4.2.1 (32-bit, 64-bit) or GCC ≥ 8 (64-bit ARM) for Linux
• GCC ≥ 4.2.1 for macOS

Java

• JDK >= 5. Make sure that the JDK has been added to your path environment variable.

.Net

• .NET SDK

Installing

Download the SDK.

Windows

• Download the Document Builder x64 or Document Builder x86 SDK archive.
• Extract the folder from the .zip file.

Linux

• Download the Document Builder aarch64 or Document Builder x86_64 SDK archive.
• Extract via tar xvzf onlyoffice-documentbuilder-linux-aarch64.tar.xz or tar xvzf onlyoffice-documentbuilder-linux-x86_64.tar.xz.

For example:

ARCH=$(uname -m)
if [[ "$ARCH" == "aarch64" || "$ARCH" == "arm64" ]]; then
    FILE_NAME="onlyoffice-documentbuilder-linux-aarch64.tar.xz"
else
    FILE_NAME="onlyoffice-documentbuilder-linux-x86_64.tar.xz"
fi

curl -L -o "$FILE_NAME" "https://github.com/ONLYOFFICE/DocumentBuilder/releases/latest/download/$FILE_NAME"

mkdir -p builder
tar xvJf "$FILE_NAME" -C builder

macOS

• Download the Document Builder arm64 or Document Builder x86_64 SDK archive.
• Extract via tar xvzf onlyoffice-documentbuilder-macos-arm64.tar.xz or tar xvzf onlyoffice-documentbuilder-macos-x86_64.tar.xz.

For example:

ARCH=$(uname -m)
if [[ "$ARCH" == "arm64" ]]; then
    FILE_NAME="onlyoffice-documentbuilder-macos-arm64.tar.xz"
else
    FILE_NAME="onlyoffice-documentbuilder-macos-x86_64.tar.xz"
fi

curl -L -o "$FILE_NAME" "https://github.com/ONLYOFFICE/DocumentBuilder/releases/latest/download/$FILE_NAME"

mkdir -p builder
tar xvJf "$FILE_NAME" -C builder

备注

For Python, you can use pip3 to install the document-builder library in the terminal:

pip3 install document-builder

Run the samples

Download the document-builder samples:

git clone https://github.com/ONLYOFFICE/document-builder-samples
cd document-builder-samples

Python

1. Execute configure.py with --test python:

   python3 configure.py --test python

   Provide the directory to Document Builder with --dir if necessary. It is needed for generating auxiliary module containing the path to Document Builder.

2. Go to the test directory:

   cd python/creating_basic_form

3. Run the script:

   python3 main.py

Documents will be created in the test directory.

C++ (VS)

NOTE: Only available on Windows.

1. Use configure.py to generate VS project files. For example:

   python configure.py --vs --test cpp/creating_basic_form --test cpp/creating_advanced_form

2. Open the .sln file in Visual Studio. It will prompt you to retarget Windows SDK and VS toolset to your installed version – click "OK".

3. The solution is ready to be built and run. Documents will be created in the project files directory.

C++ (QT)

1. Use configure.py to generate Qt project files. For example:

   python configure.py --qt --test cpp

2. Open the .pro file in Qt Creator.

3. The project is ready to be built and run. Documents will be created in the build directory.

• Makefile

NOTE: Only available on Linux and macOS.

1. Use configure.py to generate Makefile. For example:

   python configure.py --make --test cpp/filling_spreadsheet

2. Go to the directory with generated Makefile:

   cd ../out/cpp/filling_spreadsheet

3. Call:

   make

   make will build and run the executable. Documents will be created in the same directory as Makefile is.

Java

NOTE: JDK 8 or newer is required.

1. Go to the test directory:

   cd java/creating_presentation

2. Compile the Program.java providing the path to docbuilder.jar located in the Document Builder directory:

   javac -cp "C:\Program Files\ONLYOFFICE\DocumentBuilder\docbuilder.jar" Program.java

3. .class file should appear in the directory. Run the program:

   java -cp "C:\Program Files\ONLYOFFICE\DocumentBuilder\docbuilder.jar;." Program

   Note that on UNIX systems the path separator is : instead of ;. Thus, on Linux or macOS it should be:

   java -cp "/opt/onlyoffice/documentbuilder/docbuilder.jar:." Program

Documents will be created in the test directory.

.Net

NOTE: Only available on Windows with Visual Studio and .NET SDK installed.

1. Use configure.py to generate VS project files. For example:

   python configure.py --vs --test cs

2. Open the .sln file in Visual Studio. Depending on your installed .NET SDK version, you may need to set different target framework by setting it in Visual Studio project properties or editing it directly in the .csproj file.

3. The solution is ready to be built and run. Documents will be created in the project files directory.