mirror of
https://github.com/ONLYOFFICE/document-server-integration.git
synced 2026-04-07 14:06:11 +08:00
256 lines
7.9 KiB
Markdown
256 lines
7.9 KiB
Markdown
## Overview
|
|
|
|
This example will help you integrate ONLYOFFICE Docs into your web application written in Java.
|
|
|
|
It is aimed at testing the editors. Please, do not use it for production without proper modifications.
|
|
|
|
## 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 Document Server for Windows](https://helpcenter.onlyoffice.com/installation/docs-developer-install-windows.aspx).
|
|
|
|
### Step 2. Download the Java code for the editors integration
|
|
|
|
Download the [Java example](https://api.onlyoffice.com/editors/demopreview) from our site.
|
|
|
|
To connect the editors to your website, specify the path to the editors installation in the *\src\main\resources\settings.properties* file:
|
|
|
|
```
|
|
files.docservice.url.site=https://documentserver/
|
|
```
|
|
|
|
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
|
|
|
|
If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *\src\main\webapp\editor.jsp* file.
|
|
|
|
### Step 3. Install the prerequisites
|
|
|
|
To run the Java example code, install the Java version appropriate for your OS and web server **Apache Tomcat**:
|
|
|
|
* **Java** (download from [the Oracle official website](https://www.java.com/en/download/manual.jsp));
|
|
* **Apache Tomcat** (download from [the official website](http://tomcat.apache.org/)).
|
|
|
|
### Step 4. Run Apache Tomcat
|
|
|
|
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\jdk1.8.0_65
|
|
```
|
|
|
|
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\jdk1.8.0_65*.
|
|
|
|
|
|
|
|
Check if the variable created successfully by **echo** command in the **Command Prompt**:
|
|
|
|
```
|
|
echo %JAVA_HOME%
|
|
```
|
|
|
|
2. Run the **Command Prompt**. Change the current directory for the **Apache Tomcat** installation directory:
|
|
|
|
```
|
|
cd /d C:\Apache Tomcat\apache-tomcat-7.0.67\bin
|
|
```
|
|
|
|
3. Use the bin *startup.bat* script to start Apache Tomcat:
|
|
|
|
```
|
|
startup.bat
|
|
```
|
|
|
|
You will see the new **Tomcat** console window displayed that provides the information and messages about Tomcat startup:
|
|
|
|
|
|
|
|
Test your Tomcat installation using the address in a web browser:
|
|
|
|
```
|
|
http://localhost:8080
|
|
```
|
|
|
|
If everything is correct, you will see the Tomcat web page in the browser as shown below.
|
|
|
|
### Step 5. Run the Java code
|
|
|
|
1. Open Tomcat Web Application Manager by clicking **Manager App:**
|
|
|
|
|
|
|
|
2. Tomcat Web Application Manager will request the **username** and the **password:**
|
|
|
|
|
|
|
|
|
|
Specify user data in *tomcat-users.xml* file in the Apache Tomcat installation folder. Define the **manager-gui** user role, specify the **user name** and **password** values:
|
|
|
|
```
|
|
<tomcat-users>
|
|
<role rolename="manager-gui"/>
|
|
<user username="tomcat" password="tomcat" roles="manager-gui"/>
|
|
</tomcat-users>
|
|
```
|
|
|
|
3. Upload the Java project in Tomcat Web Application Manager. For that click **Choose File** in the **WAR file to deploy** section and find the *.war* file in the Java project folder, then click **Deploy**.
|
|
|
|
|
|
|
|
|
|
|
|
4. You will see the project in the **Application List**:
|
|
|
|
|
|
|
|
5. Click the link with the application name to run it.
|
|
|
|
### Step 6. Check accessibility
|
|
|
|
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.
|
|
|
|
## 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 Document Server for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx).
|
|
|
|
### Step 2. Install the prerequisites and run the website with the editors
|
|
|
|
1. Install **Java**:
|
|
|
|
```
|
|
sudo add-apt-repository ppa:webupd8team/java sudo apt-get update sudo apt-get install oracle-java8-installer
|
|
```
|
|
|
|
2. Download the archive with the Java example and unpack the archive:
|
|
|
|
```
|
|
wget https://api.onlyoffice.com/app_data/editor/Java%20Example.zip
|
|
```
|
|
|
|
```
|
|
unzip Java\ Example.zip
|
|
```
|
|
|
|
3. Change the current directory for the project directory:
|
|
|
|
```
|
|
cd Java\ Example/
|
|
```
|
|
|
|
4. Edit the *settings.properties* configuration file. Specify the name of your local server with the ONLYOFFICE Document Server installed.
|
|
|
|
```
|
|
nano src/main/resources/settings.properties
|
|
```
|
|
|
|
Edit the following line:
|
|
|
|
```
|
|
files.docservice.url.site=https://documentserver/
|
|
```
|
|
|
|
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
|
|
|
|
5. Install **Maven**:
|
|
|
|
```
|
|
sudo apt-get install maven
|
|
```
|
|
|
|
6. Build:
|
|
|
|
```
|
|
mvn package
|
|
```
|
|
|
|
7. Install **Tomcat** with the administration page:
|
|
|
|
```
|
|
sudo apt-get install tomcat8 tomcat8-admin
|
|
```
|
|
|
|
8. Configure the admin user on Tomcat:
|
|
|
|
```
|
|
sudo nano /var/lib/tomcat8/conf/tomcat-users.xml
|
|
```
|
|
|
|
Insert the lines:
|
|
|
|
```
|
|
<role rolename="manager-gui"/>
|
|
<user username="USERNAME" password="PASSWORD" roles="manager-gui"/>
|
|
```
|
|
|
|
where the **USERNAME** and **PASSWORD** are your own credentials data.
|
|
|
|
Restart Tomcat:
|
|
|
|
```
|
|
systemctl restart tomcat8
|
|
```
|
|
|
|
9. Open the Tomcat administration page in browser with the admin user credentions:
|
|
|
|
```
|
|
http://localhost:8080/manager/html
|
|
```
|
|
|
|
10. Select the WAR file to upload from *target/OnlineEditorsExampleJava-1.0.war*.
|
|
|
|
11. See the result in your browser using the address:
|
|
|
|
```
|
|
http://localhost:8080/OnlineEditorsExampleJava-1.0/
|
|
```
|
|
|
|
### Step 3. Check accessibility
|
|
|
|
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.
|
|
|
|
## For Docker
|
|
|
|
1. Edit the *settings.properties* configuration file. Specify the name of your local server with the ONLYOFFICE Document Server installed ([installation instructions](https://helpcenter.onlyoffice.com/installation/docs-developer-install-docker.aspx)).
|
|
|
|
```
|
|
nano src/main/resources/settings.properties
|
|
```
|
|
|
|
2. Edit the following line:
|
|
|
|
```
|
|
files.docservice.url.site=https://documentserver/
|
|
```
|
|
|
|
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
|
|
|
|
3. Run the next command in the Java example directory:
|
|
|
|
```
|
|
docker-compose up
|
|
```
|
|
|
|
4. After it, all the *bin* files will be passed to the *./target* folder.
|