How to integrate online editors into your own website on Java Spring

Overview

This example will help you integrate ONLYOFFICE Docs into your web application written in Java with Spring Boot.

Spring Boot has a lot of functionality, but its most significant features are: dependency management, auto-configuration, and built-in servlet containers.

The integration examples are used to demonstrate document editors functions and the ways to connect Document Server to your own application. DO NOT USE these examples on your own server without PROPER CODE MODIFICATIONS!

Download and install ONLYOFFICE Docs (packaged as Document Server).

See the detailed guide to learn how to install Document Server for Windows.

Download the Java-Spring example from our site.

To connect the editors to your website, specify the path to the editors installation, server address and port in the \src\main\resources\application.properties file:

server.address=address
server.port=port
files.docservice.url.site=https://documentserver/

where the documentserver is the name of the server with the ONLYOFFICE Docs installed, address is the server address, port is any available port. Comment the address line if you want to use localhost.

If you want to experiment with the editor configuration, modify the parameters in the \src\main\webapp\editor.jsp file.

To run the Java-Spring example code, install the Java version 11 appropriate for your OS and framework Apache Maven:

  1. After you have installed Java on Windows, set the JAVA_HOME environment variable to point to the Java installation directory.

    Find out where Java is installed. If you didn't change the path during installation, it will be something like this:

    C:\Program Files\Java\jdk11

    In Windows 7, right click My Computer and select Properties, then click Advanced.

    In Windows 8, go to Control Panel and select System, then click Advanced System Settings.

    Click the Environment Variables button.

    Under System Variables, click New.

    In the Variable Name field, enter JAVA_HOME if you installed the JDK (Java Development Kit) or JRE_HOME if you installed the JRE (Java Runtime Environment).

    In the Variable Value field, enter your JDK or JRE installation path, for example C:\Program Files\Java\jdk11.

    Check if the variable created successfully by echo command in the Command Prompt:

    echo %JAVA_HOME%
  2. Set the MAVEN_HOME environment variable:

    Unzip the downloaded archive with Maven to any directory. It will be something like this:

    C:\apache-maven-3.8.1

    In Windows 7, right click My Computer and select Properties, then click Advanced.

    In Windows 8, go to Control Panel and select System, then click Advanced System Settings.

    Click the Environment Variables button.

    Under System Variables, click New.

    In the Variable Name field, enter MAVEN_HOME.

    In the Variable Value field, enter your JDK or JRE installation path, for example C:\apache-maven-3.8.1.

    In the system variables, find PATH, click the Edit... button. In the Edit environment variable dialog, click the New button and add C:\apache-maven-3.8.1\bin to the PATH system variable.

    Check if the variable created successfully by echo command in the Command Prompt:

    echo %MAVEN_HOME%
  1. Open a console and go to the java-spring folder using the cd command:

    cd C:\Program Files\document-server-integration\web\documentserver-example\java-spring
    
  2. In the open console, enter the following commands:

    mvn clean
    mvn package
    mvn spring-boot:run
    
  3. Open your browser using server.address and server.port:

    http://server.address:server.port/
    
  4. 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 in its turn has access to the server with the example installed with the address which you specify instead of example.com in the configuration files.

    If you integrated the editors successfully the result should look like the demo preview on our site.

    Download and install ONLYOFFICE Docs (packaged as Document Server).

    See the detailed guide to learn how to install Document Server for Linux.

    1. Install Java: sudo add-apt-repository ppa:webupd8team/java sudo apt-get update sudo apt-get install oracle-java11-installer
    2. There are two ways to get the Java-Spring example:

      • download the archive with the Java-Spring example and unpack it:

        wget https://api.onlyoffice.com/app_data/editor/Java-Spring%20Example.zip unzip Java-Spring\ Example.zip
      • clone the git repository:

        git clone https://github.com/ONLYOFFICE/document-server-integration.git
    3. Change the current directory for the project directory:

      • in the archive:

        cd Java-Spring\ Example
      • in the git repository:

        cd document-server-integration/web/documentserver-example/java-spring
    4. Edit the application.properties configuration file. Specify the name of your local server with the ONLYOFFICE Docs installed.
      nano src/main/resources/application.properties

      Edit the following lines:

      server.address=address
      server.port=port
      files.docservice.url.site=https://documentserver/
      

      where the documentserver is the name of the server with the ONLYOFFICE Docs installed, address is the server address, port is any available port. Comment the address line if you want to use localhost.

    5. Install Maven:
      sudo apt-get install maven
    6. Build:
      mvn package
    7. Start Java-Spring example:

      ./mvnw spring-boot:run
    8. Open your browser using server.address and server.port:

      http://server.address:server.port/

    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 in its turn has access to the server with the example installed with the address which you specify instead of example.com in the configuration files.

    If you integrated the editors successfully the result should look like the demo preview on our site.

    1. Edit the application.properties configuration file. Specify the name of your local server with the ONLYOFFICE Docs installed.
      nano src/main/resources/application.properties

      Edit the following lines:

      server.address=address
      server.port=port
      files.docservice.url.site=https://documentserver/ 
      

      where the documentserver is the name of the server with the ONLYOFFICE Docs installed, address is the server address, port is any available port. Comment the address line if you want to use localhost.

    2. Run the next command in the Java-Spring example directory:
      docker-compose up
    3. Open your browser using server.address and server.port:

      http://server.address:server.port/