pengjunjie/document-server-integration
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/document-server-integration.git synced 2026-02-10 18:05:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

some changed for readme

Browse Source
This commit is contained in:
Natalia
2021-08-05 17:44:29 +03:00
parent efbde68bf8
commit 3142b86d9e
31 changed files with 102 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Readme.md
View File

@ -1,14 +1,18 @@
## Document Server integration example ## Integration examples
These examples show the way to integrate [ONLYOFFICE Document Server][2] into your own website or application using one of the programming languages. The package contains examples written in .Net (C# MVC), .Net (C#), Java, Node.js, PHP and Ruby. Test examples are simple document management systems that can be built into your
application for testing (please, do not use it for production without proper code
modifications).
These examples show the way to integrate [ONLYOFFICE Docs][2] into your own website or application using one of the programming languages. The package contains examples written in .Net (C# MVC), .Net (C#), Java, Node.js, PHP and Ruby.
You should change `http://documentserver` to your server address in these files: You should change `http://documentserver` to your server address in these files:
* .Net (C# MVC) - `web/documentserver-example/csharp-mvc/web.appsettings.config` * [.Net (C# MVC)](https://github.com/ONLYOFFICE/document-server-integration/tree/master/web/documentserver-example/csharp-mvc) - `web/documentserver-example/csharp-mvc/web.appsettings.config`
* .Net (C#) - `web/documentserver-example/csharp/settings.config` * [.Net (C#)](https://github.com/ONLYOFFICE/document-server-integration/tree/master/web/documentserver-example/csharp) - `web/documentserver-example/csharp/settings.config`
* Java - `web/documentserver-example/java/src/main/resources/settings.properties` * [Java](https://github.com/ONLYOFFICE/document-server-integration/tree/master/web/documentserver-example/java) - `web/documentserver-example/java/src/main/resources/settings.properties`
* Node.js - `web/documentserver-example/nodejs/config/default.json` * [Node.js](https://github.com/ONLYOFFICE/document-server-integration/tree/master/web/documentserver-example/nodejs) - `web/documentserver-example/nodejs/config/default.json`
* PHP - `web/documentserver-example/php/config.php` * [PHP](https://github.com/ONLYOFFICE/document-server-integration/tree/master/web/documentserver-example/php) - `web/documentserver-example/php/config.php`
* Ruby - `web/documentserver-example/ruby/config/application.rb` * [Ruby](https://github.com/ONLYOFFICE/document-server-integration/tree/master/web/documentserver-example/ruby) - `web/documentserver-example/ruby/config/application.rb`
More information on how to use these examples can be found here: [http://api.onlyoffice.com/editors/demopreview](http://api.onlyoffice.com/editors/demopreview "http://api.onlyoffice.com/editors/demopreview") More information on how to use these examples can be found here: [http://api.onlyoffice.com/editors/demopreview](http://api.onlyoffice.com/editors/demopreview "http://api.onlyoffice.com/editors/demopreview")

17
web/documentserver-example/README.md
View File

@ -1,17 +0,0 @@
# Integration examples
## To start integrating document editors into your own website you need to do the following:
1. Download [Document Server installation](https://www.onlyoffice.com/developer-edition-request.aspx?from=api.onlyoffice.com) and set it up on your local server.
2. Select the programming language and clone the source code for the sample of online editors integration into your web site.
3. [Edit the configuration files](https://api.onlyoffice.com/editors/advanced) in the sample changing the default path for the one to the editors installed at step 1 and other advanced parameters available for editor configuration.
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. And you must also 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.
Please note that 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**!
The result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our web site.
If you have any further questions, please contact us at [integration@onlyoffice.com](mailto:integration@onlyoffice.com).

30
web/documentserver-example/csharp-mvc/README.md
View File

@ -13,33 +13,43 @@ See the detailed guide to learn how to install Document Server [for Windows](htt
## Step 2. Download the .Net (C# MVC) code for the editors integration ## Step 2. Download the .Net (C# MVC) code for the editors integration
Download the [.Net (C# MVC) example](https://api.onlyoffice.com/editors/demopreview) from our site. Download the [.Net (C# MVC) example](https://api.onlyoffice.com/editors/demopreview) from our site.
You need to connnect the editors to your web site. Specify path to the editors installation in the *settings.config* file: You need to connnect the editors to your website. Specify path to the editors installation in the *settings.config* file:
``` ```
<add key="files.docservice.url.site" value="https://documentserver/" /> <add key="files.docservice.url.site" value="https://documentserver/" />
``` ```
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. 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) it the *DocEditor.aspx* file. If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *DocEditor.aspx* file.
## Step 3. Install the prerequisites ## Step 3. Install the prerequisites
Сheck if your system meets the system requirements: Сheck if your system meets the system requirements:
* Microsoft .NET Framework: version 4.5 (download it from the [official Microsoft website](https://www.microsoft.com/en-US/download/details.aspx?id=30653)); * **Microsoft .NET Framework**: version 4.5 (download it from the [official Microsoft website](https://www.microsoft.com/en-US/download/details.aspx?id=30653));
* Internet Information Services: version 7 or later. * **Internet Information Services**: version 7 or later.
## Step 4. Run your website with the editors ## Step 4. Run your website with the editors
1. Run the Internet Information Service (IIS) manager 1. Run the Internet Information Service (IIS) Manager:
Start -> ControlPanel -> System and Security -> Administrative Tools -> Internet Information Services (IIS) Manager
2. Add your website in the IIS Manager **Start** -> **Control Panel** -> **System and Security** -> **Administrative Tools** -> **Internet Information Services (IIS) Manager**
2. Add your website in the IIS Manager.
On the **Connections** panel right-click the **Sites** node in the tree, then click **Add Website**. On the **Connections** panel right-click the **Sites** node in the tree, then click **Add Website**.
![add](screenshots/add.png) ![add](screenshots/add.png)
3. In the **Add Website** dialog box specify the name of the folder with the .Net (C# MVC) project in the **Site name** box. 3. In the **Add Website** dialog box specify the name of the folder with the .Net (C# MVC) project in the **Site name** box.
Specify the path to the folder with your project in the **Physical Path** box. Specify the path to the folder with your project in the **Physical Path** box.
Specify the unique value used only for this website in the **Port** box. Specify the unique value used only for this website in the **Port** box.
![sitename](screenshots/sitename.png) ![sitename](screenshots/sitename.png)
4. Check for the .NET platform version specified in IIS manager for you web site. Choose **v4.0.** version. 4. Check for the .NET platform version specified in IIS Manager for you website. Choose **v4.0.** version.
Click the **Application Pool** -> right-click the platform name -> **Set application Pool defaults** -> **.NET CLR version**
**Application Pools** -> right-click the platform name -> **Set application Pool defaults** -> **.NET CLR version**
![platform](screenshots/platform.png) ![platform](screenshots/platform.png)
5. Browse your website with the IIS manager: 5. Browse your website with the IIS Manager:
Right-click the site -> **Manage Website** -> **Browse** Right-click the site -> **Manage Website** -> **Browse**
![browse](screenshots/browse.png) ![browse](screenshots/browse.png)
## Step 5. Check accessibility ## Step 5. Check accessibility

BIN
web/documentserver-example/csharp-mvc/screenshots/add.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

BIN
web/documentserver-example/csharp-mvc/screenshots/browse.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 98 KiB

BIN
web/documentserver-example/csharp-mvc/screenshots/platform.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 153 KiB

BIN
web/documentserver-example/csharp-mvc/screenshots/sitename.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 95 KiB

29
web/documentserver-example/csharp/README.md
View File

@ -20,29 +20,40 @@ Connect the editors to your website by specifying the path to the editors instal
``` ```
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. 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) it the *DocEditor.aspx* file. If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *DocEditor.aspx* file.
## Step 3. Install the prerequisites ## Step 3. Install the prerequisites
Check that your system meets the requirements: Check that your system meets the requirements:
* Microsoft .NET Framework: version 4.5 (download it from the [official Microsoft website](https://www.microsoft.com/en-US/download/details.aspx?id=30653)); * **Microsoft .NET Framework**: version 4.5 (download it from the [official Microsoft website](https://www.microsoft.com/en-US/download/details.aspx?id=30653));
* Internet Information Services: version 7 or later. * **Internet Information Services**: version 7 or later.
## Step 4. Run your website with the editors ## Step 4. Run your website with the editors
1. Run the Internet Information Service (IIS) manager 1. Run the Internet Information Service (IIS) Manager:
Start -> ControlPanel -> System and Security -> Administrative Tools -> Internet Information Services (IIS) Manager
2. Add your website in the IIS Manager **Start** -> **Control Panel** -> **System and Security** -> **Administrative Tools** -> **Internet Information Services (IIS) Manager**
2. Add your website in the IIS Manager.
On the **Connections** panel right-click the **Sites** node in the tree, then click **Add Website**. On the **Connections** panel right-click the **Sites** node in the tree, then click **Add Website**.
![add](screenshots/add.png) ![add](screenshots/add.png)
3. In the **Add Website** dialog box specify the name of the folder with the .Net (C#) project in the **Site name** box. 3. In the **Add Website** dialog box specify the name of the folder with the .Net (C#) project in the **Site name** box.
Specify the path to the folder with your project in the **Physical Path** box. Specify the path to the folder with your project in the **Physical Path** box.
Specify the unique value used only for this website in the **Port** box. Specify the unique value used only for this website in the **Port** box.
![sitename](screenshots/sitename.png) ![sitename](screenshots/sitename.png)
4. Check for the .NET platform version specified in IIS manager for you website. Choose **v4.0.** version. 4. Check for the .NET platform version specified in IIS Manager for you website. Choose **v4.0.** version.
Click the **Application Pool** -> right-click the platform name -> **Set application Pool defaults** -> **.NET CLR version**
**Application Pools** -> right-click the platform name -> **Set application Pool defaults** -> **.NET CLR version**
![platform](screenshots/platform.png) ![platform](screenshots/platform.png)
5. Browse your website with the IIS manager: 5. Browse your website with the IIS Manager:
Right-click the site -> **Manage Website** -> **Browse** Right-click the site -> **Manage Website** -> **Browse**
![browse](screenshots/browse.png) ![browse](screenshots/browse.png)
## Step 5. Check accessibility ## Step 5. Check accessibility

BIN
web/documentserver-example/csharp/screenshots/add.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

BIN
web/documentserver-example/csharp/screenshots/browse.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 98 KiB

BIN
web/documentserver-example/csharp/screenshots/platform.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 153 KiB

BIN
web/documentserver-example/csharp/screenshots/sitename.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 95 KiB

40
web/documentserver-example/java/README.md
View File

@ -10,7 +10,7 @@ It is aimed at testing the editors. Please, do not use it for production without
Download and install ONLYOFFICE Docs (packaged as Document Server). 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). 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 ### Step 2. Download the Java code for the editors integration
@ -24,14 +24,14 @@ files.docservice.url.site=https://documentserver/
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. 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) it the *\src\main\webapp\editor.jsp* file. 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 ### Step 3. Install the prerequisites
To run the Java example code, install the Java version appropriate for your OS and web server **Apache Tomcat**: 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)); * **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/)). * **Apache Tomcat** (download from [the official website](http://tomcat.apache.org/)).
### Step 4. Run Apache Tomcat ### Step 4. Run Apache Tomcat
@ -43,9 +43,9 @@ To run the Java example code, install the Java version appropriate for your OS a
C:\Program Files\Java\jdk1.8.0_65 C:\Program Files\Java\jdk1.8.0_65
``` ```
In **Windows 7** right click **My Computer** and select **Properties**, then click **Advanced**. In **Windows 7**, right click **My Computer** and select **Properties**, then click **Advanced**.
In **Windows 8** go to **Control Panel** -> **System** -> **Advanced System Settings**. In **Windows 8**, go to **Control Panel** and select **System**, then click **Advanced System Settings**.
Click the **Environment Variables** button. Click the **Environment Variables** button.
@ -53,7 +53,7 @@ To run the Java example code, install the Java version appropriate for your OS a
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 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. In the **Variable Value** field, enter your **JDK** or **JRE** installation path, for example *C:\Program Files\Java\jdk1.8.0_65*.
![make-var](screenshots/make-var.png) ![make-var](screenshots/make-var.png)
@ -94,6 +94,7 @@ To run the Java example code, install the Java version appropriate for your OS a
![manager](screenshots/manager.jpg) ![manager](screenshots/manager.jpg)
2. Tomcat Web Application Manager will request the **username** and the **password:** 2. Tomcat Web Application Manager will request the **username** and the **password:**
![author](screenshots/author.jpg) ![author](screenshots/author.jpg)
@ -106,11 +107,14 @@ To run the Java example code, install the Java version appropriate for your OS a
</tomcat-users> </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**. 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**.
![upload-app](screenshots/upload-app.jpg) ![upload-app](screenshots/upload-app.jpg)
![war-file](screenshots/war-file.jpg) ![war-file](screenshots/war-file.jpg)
4. You will see the project in the **Application List**: 4. You will see the project in the **Application List**:
![manager-app](screenshots/manager-app.jpg) ![manager-app](screenshots/manager-app.jpg)
5. Click the link with the application name to run it. 5. Click the link with the application name to run it.
@ -127,7 +131,7 @@ Make sure that the Document Server has access to the server with the example ins
Download and install ONLYOFFICE Docs (packaged as Document Server). 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). 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 ### Step 2. Install the prerequisites and run the website with the editors
@ -159,13 +163,13 @@ See the detailed guide to learn how to install Document Server [for Linux](https
nano src/main/resources/settings.properties nano src/main/resources/settings.properties
``` ```
Edit the following lines: Edit the following line:
``` ```
files.docservice.url.site=https://documentserver/ files.docservice.url.site=https://documentserver/
``` ```
Where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
5. Install **Maven**: 5. Install **Maven**:
@ -191,22 +195,22 @@ See the detailed guide to learn how to install Document Server [for Linux](https
sudo nano /var/lib/tomcat8/conf/tomcat-users.xml sudo nano /var/lib/tomcat8/conf/tomcat-users.xml
``` ```
Insert the line: Insert the lines:
``` ```
<role rolename="manager-gui"/> <role rolename="manager-gui"/>
<user username="USERNAME" password="PASSWORD" roles="manager-gui"/> <user username="USERNAME" password="PASSWORD" roles="manager-gui"/>
``` ```
Where the **USERNAME** and **PASSWORD** are your own credentials data. where the **USERNAME** and **PASSWORD** are your own credentials data.
Restart tomcat: Restart Tomcat:
``` ```
systemctl restart tomcat8 systemctl restart tomcat8
``` ```
9. Open the tomcat administration page in browser with the admin user credentions: 9. Open the Tomcat administration page in browser with the admin user credentions:
``` ```
http://localhost:8080/manager/html http://localhost:8080/manager/html
@ -234,15 +238,15 @@ Make sure that the Document Server has access to the server with the example ins
nano src/main/resources/settings.properties nano src/main/resources/settings.properties
``` ```
2. Edit the following lines: 2. Edit the following line:
``` ```
files.docservice.url.site=https://documentserver/ files.docservice.url.site=https://documentserver/
``` ```
Where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. 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: 3. Run the next command in the Java example directory:
``` ```
docker-compose up docker-compose up

BIN
web/documentserver-example/java/screenshots/author.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 55 KiB

BIN
web/documentserver-example/java/screenshots/make-var.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 139 KiB

After

Width:  |  Height:  |  Size: 183 KiB

BIN
web/documentserver-example/java/screenshots/manager-app.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 84 KiB

BIN
web/documentserver-example/java/screenshots/manager.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 183 KiB

After

Width:  |  Height:  |  Size: 207 KiB

BIN
web/documentserver-example/java/screenshots/tomcat-cmd.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 95 KiB

After

Width:  |  Height:  |  Size: 101 KiB

BIN
web/documentserver-example/java/screenshots/upload-app.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 47 KiB

BIN
web/documentserver-example/java/screenshots/war-file.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 104 KiB

12
web/documentserver-example/nodejs/README.md
View File

@ -24,15 +24,15 @@ You need to connect the editors to your website. Specify the path to the editors
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. 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) it the *\views\editor.ejs* file. If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *\views\editor.ejs* file.
### Step 3. Install Node.js environment ### Step 3. Install Node.js environment
Install the **node.js** environment which is going to be used to run the Node.js project. Please follow the link at the official website: https://nodejs.org/en/download/ choosing the correct version for your Windows OS (32-bit or 64-bit). Install the **node.js** environment which is going to be used to run the Node.js project. Please follow the link at the [official website](https://nodejs.org/en/download/) choosing the correct version for your Windows OS (32-bit or 64-bit).
### Step 4. Run the Node.js code ### Step 4. Run the Node.js code
We will run the code in Node.js runtime environment and will interact with it using the command line interface (cmd). We will run the code in Node.js runtime environment and will interact with it using the **command line interface (cmd)**.
1. Launch the **Command Prompt** and switch to the folder with the Node.js project code, for example: 1. Launch the **Command Prompt** and switch to the folder with the Node.js project code, for example:
@ -40,7 +40,7 @@ We will run the code in Node.js runtime environment and will interact with it us
cd /d "C:\Node.js Example" cd /d "C:\Node.js Example"
``` ```
2. Node.js comes with a package manager, **node package manager (npm)**, which is automatically installed along with Node.js. To run the Node.js code, install the project modules using the following npm command: 2. Node.js comes with a package manager, **node package manager (npm)**, which is automatically installed along with Node.js. To run the Node.js code, install the project modules using the following *npm* command:
``` ```
npm install npm install
@ -114,13 +114,13 @@ See the detailed guide to learn how to [install Document Server for Linux](https
nano config/default.json nano config/default.json
``` ```
Edit the following lines: Edit the following line:
``` ```
"siteUrl": "https://documentserver/" "siteUrl": "https://documentserver/"
``` ```
Where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
6. Run the project with Node.js: 6. Run the project with Node.js:

34
web/documentserver-example/php/README.md
View File

@ -12,7 +12,7 @@ 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?from=api_php_example). See the detailed guide to learn how to [install Document Server for Windows](https://helpcenter.onlyoffice.com/installation/docs-developer-install-windows.aspx?from=api_php_example).
### Step 2. Download the PHP code ### Step 2. Download the PHP code for the editors integration
Download the [PHP example](https://api.onlyoffice.com/editors/demopreview) from our site. Download the [PHP example](https://api.onlyoffice.com/editors/demopreview) from our site.
@ -24,13 +24,13 @@ $GLOBALS['DOC_SERV_SITE_URL'] = "https://documentserver/";
where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. 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) it the *doceditor.php* file. If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *doceditor.php* file.
### Step 3. Install the prerequisites ### Step 3. Install the prerequisites
You can use any web server capable of runnig PHP code to run the example. We will demonstrate how to run the PHP example using the **Internet Information Services (IIS)** web server. To set up and configure PHP on IIS, **PHP Manager for IIS** will be used. You can use any web server capable of running PHP code to run the example. We will demonstrate how to run the PHP example using the **Internet Information Services (IIS)** web server. To set up and configure PHP on IIS, **PHP Manager for IIS** will be used.
* **IIS: version 7** or later (refer to [Microsoft official website](https://www.iis.net/learn/application-frameworks/scenario-build-a-php-website-on-iis/configuring-step-1-install-iis-and-php) to learn how to install **IIS**); * **IIS**: version 7 or later (refer to [Microsoft official website](https://www.iis.net/learn/application-frameworks/scenario-build-a-php-website-on-iis/configuring-step-1-install-iis-and-php) to learn how to install IIS);
* **PHP** (download it from the [http://php.net](https://php.net/downloads.php) site); * **PHP** (download it from the [http://php.net](https://php.net/downloads.php) site);
* **PHP Manager for IIS** (download it from the [Microsoft open source site](https://phpmanager.codeplex.com/releases/view/69115)). * **PHP Manager for IIS** (download it from the [Microsoft open source site](https://phpmanager.codeplex.com/releases/view/69115)).
@ -38,15 +38,15 @@ You can use any web server capable of runnig PHP code to run the example. We wil
1. **PHP Manager for IIS** configuration. 1. **PHP Manager for IIS** configuration.
After **PHP Manager for IIS** installation is complete, launch the **IIS Manager:** After PHP Manager for IIS installation is complete, launch the **IIS Manager:**
Start -> ControlPanel -> System and Security -> Administrative Tools -> Internet Information Services (IIS) Manager **Start** -> **Control Panel** -> **System and Security** -> **Administrative Tools** -> **Internet Information Services (IIS) Manager**
and find the **PHP Manager** feature in the **Features View** in **IIS**. and find the **PHP Manager** feature in the **Features View** in IIS.
![manager](screenshots/manager.png) ![manager](screenshots/manager.png)
You need to register the installed PHP version in **IIS** using **PHP Manager**. You need to register the installed PHP version in IIS using PHP Manager.
Double-click **PHP Manager** to open it, click the **Register new PHP version** task and specify the full path to the main PHP executable file location. For example: *C:\Program Files\PHP\php-cgi.exe*. Double-click **PHP Manager** to open it, click the **Register new PHP version** task and specify the full path to the main PHP executable file location. For example: *C:\Program Files\PHP\php-cgi.exe*.
@ -58,7 +58,7 @@ You can use any web server capable of runnig PHP code to run the example. We wil
2. Configure IIS to handle PHP requests. 2. Configure IIS to handle PHP requests.
For IIS to host PHP applications, you must add handler mapping that tells IIS to pass all the PHP-specific requests to the PHP application framework by using the FastCGI protocol. For IIS to host PHP applications, you must add handler mapping that tells IIS to pass all the PHP-specific requests to the PHP application framework by using the **FastCGI** protocol.
Double-click the **Handler Mappings** feature: Double-click the **Handler Mappings** feature:
@ -66,16 +66,16 @@ You can use any web server capable of runnig PHP code to run the example. We wil
In the **Action** panel, click **Add Module Mapping**. In the **Add Module Mapping** dialog box, specify the configuration settings as follows: In the **Action** panel, click **Add Module Mapping**. In the **Add Module Mapping** dialog box, specify the configuration settings as follows:
* Request path: ***.php**, * **Request path**: *.php,
* Module: **FastCgiModule**, * **Module**: FastCgiModule,
* Executable: **"C:\[Path to your PHP installation]\php-cgi.exe"**, * **Executable**: "C:\[Path to your PHP installation]\php-cgi.exe",
* Name: **PHP via FastCGI**. * **Name**: PHP via FastCGI.
Click **OK**. Click **OK**.
![handler-add](screenshots/handler-add.png) ![handler-add](screenshots/handler-add.png)
After IIS manager configuration is complete, everything is ready for running the **PHP** example. After IIS manager configuration is complete, everything is ready for running the PHP example.
### Step 5. Run your website with the editors ### Step 5. Run your website with the editors
@ -87,7 +87,7 @@ You can use any web server capable of runnig PHP code to run the example. We wil
2. In the **Add Website** dialog box, specify the name of the folder with the PHP project in the **Site name** box. 2. In the **Add Website** dialog box, specify the name of the folder with the PHP project in the **Site name** box.
Specify the path to the folder with your project in the **Physical Path** box. Specify the path to the folder with your project in the **Physical path** box.
Specify the unique value used only for this website in the **Port** box. Specify the unique value used only for this website in the **Port** box.
@ -147,13 +147,13 @@ See the detailed guide to learn how to [install Document Server for Linux](https
nano config.php nano config.php
``` ```
Edit the following lines: Edit the following line:
``` ```
$GLOBALS['DOC_SERV_SITE_URL'] = "https://documentserver/"; $GLOBALS['DOC_SERV_SITE_URL'] = "https://documentserver/";
``` ```
Where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
5. Set permission for site: 5. Set permission for site:

BIN
web/documentserver-example/php/screenshots/browse.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 21 KiB

BIN
web/documentserver-example/php/screenshots/handler-add.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 120 KiB

After

Width:  |  Height:  |  Size: 123 KiB

BIN
web/documentserver-example/php/screenshots/handlerclick.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

BIN
web/documentserver-example/php/screenshots/manager.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 71 KiB

After

Width:  |  Height:  |  Size: 71 KiB

BIN
web/documentserver-example/php/screenshots/php-add.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 19 KiB

BIN
web/documentserver-example/php/screenshots/php-version-1.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 67 KiB

BIN
web/documentserver-example/php/screenshots/php-version-2.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 49 KiB

8
web/documentserver-example/python/readme.md
View File

@ -12,7 +12,7 @@ See the detailed guide to learn how to install Document Server [for Windows](htt
## Step 2. Install the prerequisites and run the website with the editors ## Step 2. Install the prerequisites and run the website with the editors
1. Python comes preinstalled on most Linux distributions, and is available as a package on all others. Python 3.9 is required. Please proceed to [official documentation](https://docs.python.org/3/using/unix.html) if you have any troubles. 1. **Python** comes preinstalled on most Linux distributions, and is available as a package on all others. Python 3.9 is required. Please proceed to [official documentation](https://docs.python.org/3/using/unix.html) if you have any troubles.
2. Download the archive with the Python example and unpack it: 2. Download the archive with the Python example and unpack it:
@ -45,15 +45,13 @@ See the detailed guide to learn how to install Document Server [for Windows](htt
nano config.py nano config.py
``` ```
Edit the following lines: Edit the following line:
``` ```
DOC_SERV_SITE_URL = 'https://documentserver/' DOC_SERV_SITE_URL = 'https://documentserver/'
``` ```
Where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
And the **exampleserver** is the name of the server with the Python Example.
6. Run the **Python** server: 6. Run the **Python** server:

4
web/documentserver-example/ruby/README.md
View File

@ -50,13 +50,13 @@ See the detailed guide to learn how to install Document Server [for Windows](htt
nano config/application.rb nano config/application.rb
``` ```
Edit the following lines: Edit the following line:
``` ```
Rails.configuration.urlSite="https://documentserver/" Rails.configuration.urlSite="https://documentserver/"
``` ```
Where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed.
6. Run the **Rails** application: 6. Run the **Rails** application: