Java Spring example
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.
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.
Important 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 Docs.
- There are no prohibitions on using test examples from other sites, since they are intended to interact with ONLYOFFICE Docs from another domain.
For Windows
Step 1. Install ONLYOFFICE Docs
Download and install ONLYOFFICE Docs (packaged as Document Server):
See the detailed guide to learn how to install ONLYOFFICE Docs for Windows.
Step 2. Download the Java code for the editors integration
Download the Java-Spring example from our site.
To connect the editors to your website, specify the path to the editors installation and the path to the storage folder in the src/main/resources/application.properties file:
files.storage=
server.port=port
files.docservice.url.site=https://documentserver/
where the documentserver is the name of the server with the ONLYOFFICE Docs installed, port is any available port and files.storage is the path where files will be created and stored (in the project folder by default). You can set an absolute path. For example, D:\\folder. Please note that on Windows OS the double backslash must be used as a separator.
If you want to experiment with the editor configuration, modify the parameters in the src/main/webapp/editor.jsp file.
Step 3. Install the prerequisites
To run the Java-Spring example code, install the Java version 11 appropriate for your OS and framework Apache Maven:
- Java (download from the Oracle official website);
- Apache Maven (download from the official website).
Step 4. Set environment variables
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\jdk11In 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%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.1In 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%
Step 5 . Start application with Maven
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-springIn the open console, enter the following commands:
mvn clean mvn package mvn spring-boot:runOpen your browser using server.address and server.port:
http://server.address:server.port/
Step 6. Check accessibility
In case the example and ONLYOFFICE Docs are installed on different computers, make sure that your server with the example installed has access to the ONLYOFFICE Docs with the address which you specify instead of documentserver in the configuration files. Make sure that the ONLYOFFICE Docs 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.
For Linux
Step 1. Install ONLYOFFICE Docs
Download and install ONLYOFFICE Docs (packaged as Document Server):
See the detailed guide to learn how to install ONLYOFFICE Docs for Linux.
Step 2. Install the prerequisites and run the website with the editors
Install Java following the instructions here.
There are two ways to get the Java-Spring example:
- download the archive with the Java-Spring example and unpack it:
wget https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Java.Spring.Example.zipunzip Java.Spring.Example.zip- clone the git repository:
git clone https://github.com/ONLYOFFICE/document-server-integration.gitChange 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-springEdit the src/main/resources/application.properties configuration file. Specify the name of your local server with the ONLYOFFICE Docs installed.
nano src/main/resources/application.propertiesEdit the following lines:
files.storage= server.port=port files.docservice.url.site=https://documentserver/where the documentserver is the name of the server with the ONLYOFFICE Docs installed, port is any available port and files.storage is the path where files will be created and stored (in the project folder by default). You can set an absolute path.
Install Maven:
sudo apt-get install mavenBuild:
mvn packageStart Java-Spring example:
./mvnw spring-boot:runOpen your browser using server.address and server.port:
http://server.address:server.port/
Step 3. Check accessibility
In case the example and ONLYOFFICE Docs are installed on different computers, make sure that your server with the example installed has access to the ONLYOFFICE Docs with the address which you specify instead of documentserver in the configuration files. Make sure that the ONLYOFFICE Docs 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.
For Docker
Step 1. Install ONLYOFFICE Docs
Download and install ONLYOFFICE Docs (packaged as Document Server):
See the detailed guide to learn how to install ONLYOFFICE Docs for Docker.
Step 2. Install the prerequisites and run the website with the editors
Install Java following the instructions here.
There are two ways to get the Java-Spring example:
- download the archive with the Java-Spring example and unpack it:
wget https://github.com/ONLYOFFICE/document-server-integration/releases/latest/download/Java.Spring.Example.zipunzip Java.Spring.Example.zip- clone the git repository:
git clone https://github.com/ONLYOFFICE/document-server-integration.gitChange 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-springEdit the src/main/resources/application.properties configuration file. Specify the name of your local server with ONLYOFFICE Docs installed:
nano src/main/resources/application.propertiesEdit the following lines:
files.storage= server.port=port files.docservice.url.site=https://documentserver/where the documentserver is the name of the server with the ONLYOFFICE Docs installed, port is any available port and files.storage is the path where files will be created and stored (in the project folder by default). You can set an absolute path.
Run the next command in the Java-Spring example directory:
docker-compose upOpen your browser using server.address and server.port:
http://server.address:server.port/
Step 3. Check accessibility
In case the example and ONLYOFFICE Docs are installed on different computers, make sure that your server with the example installed has access to the ONLYOFFICE Docs with the address which you specify instead of documentserver in the configuration files. Make sure that the ONLYOFFICE Docs 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.