diff --git a/web/documentserver-example/csharp-mvc/README.md b/web/documentserver-example/csharp-mvc/README.md index e6207fe9..75da3e46 100644 --- a/web/documentserver-example/csharp-mvc/README.md +++ b/web/documentserver-example/csharp-mvc/README.md @@ -1,35 +1,34 @@ -## How to integrate online editors into your own web site on .Net (C# MVC) -### Introduction -To integrate **ONLYOFFICE online editors** into your own website on **.Net (C# MVC)** you need to download and install ONLYOFFICE editors on your local server and use the [.Net (C# MVC) example](https://api.onlyoffice.com/editors/demopreview) for their integration. +## Overview -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**! +This example will help you integrate ONLYOFFICE Docs into your web application written in .Net (C# MVC). -This guide will show you the sequence of actions to integrate the editors successfully. +It is aimed at testing the editors. Please, do not use it for production without proper modifications. -### Step 1. Download and Install Document Server +## Step 1. Install ONLYOFFICE Docs -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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_csharp_example), [for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx?from=api_csharp_example), or [for Docker](https://helpcenter.onlyoffice.com/server/developer-edition/docker/docker-installation.aspx?from=api_csharp_example). +Download and install ONLYOFFICE Docs (packaged as Document Server). -### Step 2. Download the .Net (C# MVC) code for the editors integration +See the detailed guide to learn how to install Document Server [for Windows](https://helpcenter.onlyoffice.com/installation/docs-developer-install-windows.aspx), [for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx), or [for Docker](https://helpcenter.onlyoffice.com/server/developer-edition/docker/docker-installation.aspx). + +## 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. -You need to connnect the editors to your web site. For that specify the path to the editors installation in the *settings.config* file: +You need to connnect the editors to your web site. Specify path to the editors installation in the *settings.config* file: ``` ``` 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. -### Step 3. Install the prerequisites -To run your website with the editors successfully, check if your system meets the necessary system requirements: +## Step 3. Install the prerequisites +С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)); * Internet Information Services: version 7 or later. -### Step 4. Running your web site with the editors +## Step 4. Run your website with the editors 1. Run the Internet Information Service (IIS) manager Start -> ControlPanel -> System and Security -> Administrative Tools -> Internet Information Services (IIS) Manager -2. Add your web site in the 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**. ![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. @@ -39,11 +38,12 @@ To run your website with the editors successfully, check if your system meets th 4. Check for the .NET platform version specified in IIS manager for you web site. Choose **v4.0.** version. Click the **Application Pool** -> right-click the platform name -> **Set application Pool defaults** -> **.NET CLR version** ![platform](screenshots/platform.png) -5. Browse your web site with the IIS manager: +5. Browse your website with the IIS manager: Right-click the site -> **Manage Website** -> **Browse** ![browse](screenshots/browse.png) -### Step 5. Checking accessibility +## Step 5. 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. 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. -If you integrated the editors successfully the result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our site. \ No newline at end of file +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. diff --git a/web/documentserver-example/csharp/README.md b/web/documentserver-example/csharp/README.md index 58af74ad..5aefecfa 100644 --- a/web/documentserver-example/csharp/README.md +++ b/web/documentserver-example/csharp/README.md @@ -1,49 +1,52 @@ -## How to integrate online editors into your own web site on .Net (C#) -### Introduction -To integrate **ONLYOFFICE online editors** into your own website on **.Net (C#)** you need to download and install ONLYOFFICE editors on your local server and use the [.Net (C#) example](https://api.onlyoffice.com/editors/demopreview) for their integration. +## Overview -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**! +This example will help you integrate ONLYOFFICE Docs into your web application written in .Net (C#). -This guide will show you the sequence of actions to integrate the editors successfully. +It is aimed at testing the editors. Please, do not use it for production without proper modifications. -### Step 1. Download and Install Document Server +## Step 1. Install ONLYOFFICE Docs -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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_csharp_example), [for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx?from=api_csharp_example), or [for Docker](https://helpcenter.onlyoffice.com/server/developer-edition/docker/docker-installation.aspx?from=api_csharp_example). +Download and install ONLYOFFICE Docs (packaged as Document Server). -### Step 2. Download the .Net (C#) code for the editors integration +See the detailed guide to learn how to install Document Server [for Windows](https://helpcenter.onlyoffice.com/installation/docs-developer-install-windows.aspx), [for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx), or [for Docker](https://helpcenter.onlyoffice.com/server/developer-edition/docker/docker-installation.aspx). + +## Step 2. Download the .Net (C#) code for the editors integration Download the [.Net (C#) example](https://api.onlyoffice.com/editors/demopreview) from our site. -You need to connnect the editors to your web site. For that specify the path to the editors installation in the *settings.config* file: + +Connect the editors to your website by specifying the path to the editors installation in the *settings.config* file: ``` ``` 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. -### Step 3. Install the prerequisites -To run your website with the editors successfully, check if your system meets the necessary system requirements: +## Step 3. Install the prerequisites + +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)); * Internet Information Services: version 7 or later. -### Step 4. Running your web site with the editors +## Step 4. Run your website with the editors 1. Run the Internet Information Service (IIS) manager Start -> ControlPanel -> System and Security -> Administrative Tools -> Internet Information Services (IIS) Manager -2. Add your web site in the 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**. ![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. 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. ![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** ![platform](screenshots/platform.png) -5. Browse your web site with the IIS manager: +5. Browse your website with the IIS manager: Right-click the site -> **Manage Website** -> **Browse** ![browse](screenshots/browse.png) -### Step 5. Checking accessibility +## Step 5. 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. 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. -If you integrated the editors successfully the result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our site. \ No newline at end of file +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. diff --git a/web/documentserver-example/java/README.md b/web/documentserver-example/java/README.md index 0204ae8b..5ae46e85 100644 --- a/web/documentserver-example/java/README.md +++ b/web/documentserver-example/java/README.md @@ -1,28 +1,22 @@ -# How to integrate online editors into your own web site on Java +## Overview -## Introduction +This example will help you integrate ONLYOFFICE Docs into your web application written in Java. -To integrate **ONLYOFFICE online editors** into your own website on **Java** you need to download and install ONLYOFFICE editors on your local server and use the [Java Example](https://api.onlyoffice.com/editors/demopreview) for their integration. +It is aimed at testing the editors. Please, do not use it for production without proper modifications. -You can choose any appropriate way how to run the Java example code. We will show how to run the Java code using the **Apache Tomcat** web server on [Windows OS](#running-the-example-on-windows-os) and [Linux OS](#running-the-example-on-linux-os). +## For Windows -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**! +### Step 1. Install ONLYOFFICE Docs -This guide will show you the sequence of actions to integrate the editors successfully. +Download and install ONLYOFFICE Docs (packaged as Document Server). -## Running the example on Windows OS +See the detailed guide to learn how to install Document Server [for Windows](https://helpcenter.onlyoffice.com/installation/docs-developer-install-windows.aspx). -## Step 1. Download and Install Document Server - -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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_java_example). - -## Step 2. Download the Java code for the editors integration +### Step 2. Download the Java code for the editors integration Download the [Java example](https://api.onlyoffice.com/editors/demopreview) from our site. -You need to connect the editors to your web site. For that specify the path to the editors installation in the *\src\main\resources\settings.properties* file: +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/ @@ -32,16 +26,16 @@ where the **documentserver** is the name of the server with the ONLYOFFICE Docum 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. -## Step 3. Install the prerequisites +### Step 3. Install the prerequisites -To run the Java example code you will need to 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 web site](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/)). -## Step 4. Running Apache Tomcat +### Step 4. Run Apache Tomcat -1. After you have installed Java in Windows, you must set the **JAVA_HOME** environment variable to point to the Java installation directory. +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: @@ -93,7 +87,7 @@ To run the Java example code you will need to install the Java version appropria If everything is correct, you will see the Tomcat web page in the browser as shown below. -## Step 5 . Running the Java code +### Step 5. Run the Java code 1. Open Tomcat Web Application Manager by clicking **Manager App:** @@ -103,7 +97,7 @@ To run the Java example code you will need to install the Java version appropria ![author](screenshots/author.jpg) - For that you will need to 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: + 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: ``` @@ -121,21 +115,21 @@ To run the Java example code you will need to install the Java version appropria 5. Click the link with the application name to run it. -## Step 6. Checking accessibility +### 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. 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. +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. -If you integrated the editors successfully the result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our site. +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. -## Running the example on Linux OS +## For Linux -## Step 1. Download and Install Document Server +### Step 1. Install ONLYOFFICE Docs -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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?from=api_java_example). +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 web site with the editors +### Step 2. Install the prerequisites and run the website with the editors 1. Install **Java**: @@ -226,15 +220,15 @@ See the detailed guide to learn how to [install Document Server for Linux](https http://localhost:8080/OnlineEditorsExampleJava-1.0/ ``` -## Step 3. Checking accessibility +### 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. 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. +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. -If you integrated the editors successfully the result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our site. +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. -## Build from Docker +## For Docker -1. Edit the *settings.properties* configuration file. Specify the name of your local server with the ONLYOFFICE Document Server installed. +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 @@ -254,4 +248,4 @@ If you integrated the editors successfully the result should look like the [demo docker-compose up ``` -4. After it, all the *bin* files will be passed to the *./target* folder. \ No newline at end of file +4. After it, all the *bin* files will be passed to the *./target* folder. diff --git a/web/documentserver-example/nodejs/README.md b/web/documentserver-example/nodejs/README.md index 0b9dbcc3..288ce7c0 100644 --- a/web/documentserver-example/nodejs/README.md +++ b/web/documentserver-example/nodejs/README.md @@ -1,26 +1,22 @@ -# How to integrate online editors into your own web site on Node.js +## Overview -## Introduction +This example will help you integrate ONLYOFFICE Docs into your web application on Node.js. -To integrate **ONLYOFFICE online editors** into your own website on **Node.js** you need to download and install ONLYOFFICE editors on your local server and use the [Node.js Example](https://api.onlyoffice.com/editors/demopreview) for their integration. We will show you how to run the Node.js example on [Windows OS](#running-the-example-on-windows-os) and [Linux OS](#running-the-example-on-linux-os). +It is aimed at testing the editors. Please, do not use it for production without proper modifications. -Please nore 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**! +## For Windows -This guide will show you the sequence of actions to integrate the editors successfully. +### Step 1. Install ONLYOFFICE Docs -## Running the example on Windows OS +Download and install ONLYOFFICE Docs (packaged as Document Server). -## Step 1. Download and Install 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). -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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_nodejs_example). - -## Step 2. Download the Node.js code for the editors integration +### Step 2. Download the Node.js code for the editors integration Download the [Node.js example](https://api.onlyoffice.com/editors/demopreview) from our site. -You need to connect the editors to your web site. For that specify the path to the editors installation in the *config/default.json* file: +You need to connect the editors to your website. Specify the path to the editors installation in the *config/default.json* file: ``` "siteUrl": "https://documentserver/" @@ -30,11 +26,11 @@ where the **documentserver** is the name of the server with the ONLYOFFICE Docum If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) it the *\views\editor.ejs* file. -## Step 3. System requirements +### Step 3. Install Node.js environment -Download and 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. Running 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). @@ -64,19 +60,21 @@ We will run the code in Node.js runtime environment and will interact with it us http://localhost:3000 ``` -## Step 5. Checking accessibility +### Step 5. 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. 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. +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. -## Running the example on Linux OS +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. -## Step 1. Download and Install Document Server +## For Linux -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE Document Server). +### Step 1. Install ONLYOFFICE Docs -See the detailed guide to learn how to [install Document Server for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx?from=api_nodejs_example). +Download and install ONLYOFFICE Docs (packaged as Document Server). -## Step 2. Install the prerequisites and run the web site with the editors +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 **Node.js**: @@ -88,7 +86,7 @@ See the detailed guide to learn how to [install Document Server for Linux](https sudo apt-get install -y nodejs ``` -2. Download the archive with the Node.js example and unpack the archive: +2. Download the archive with the Node.js example and unpack it: ``` wget https://api.onlyoffice.com/app_data/editor/Node.js%20Example.zip @@ -136,6 +134,8 @@ See the detailed guide to learn how to [install Document Server for Linux](https http://localhost:3000 ``` -## Step 3. Checking accessibility +### 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. 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. \ No newline at end of file +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. diff --git a/web/documentserver-example/php/README.md b/web/documentserver-example/php/README.md index f64d3658..3760a60f 100644 --- a/web/documentserver-example/php/README.md +++ b/web/documentserver-example/php/README.md @@ -1,26 +1,22 @@ -# How to integrate online editors into your own web site on PHP +## Overview -## Introduction +This example will help you integrate ONLYOFFICE Docs into your web application written in PHP. -To integrate **ONLYOFFICE online editors** into your own website on **PHP** you need to download and install ONLYOFFICE editors on your local server and use the [PHP Example](https://api.onlyoffice.com/editors/demopreview) for their integration. We will show you how to run the PHP example on [Windows OS](#running-the-example-on-windows-os) and [Linux OS](#running-the-example-on-linux-os). +It is aimed at testing the editors. Please, do not use it for production without proper modifications. -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**! +## For Windows -This guide will show you the sequence of actions to integrate the editors successfully. +### Step 1. Install ONLYOFFICE Docs -## Running the example on Windows OS - -## Step 1. Download and Install Document Server - -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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?from=api_php_example). -## Step 2. Download the PHP code for the editors integration +### Step 2. Download the PHP code Download the [PHP example](https://api.onlyoffice.com/editors/demopreview) from our site. -You need to connect the editors to your web site. For that specify the path to the editors installation in the *config.php* file: +You need to connect the editors to your website. Specify the path to the editors installation in the *config.php* file: ``` $GLOBALS['DOC_SERV_SITE_URL'] = "https://documentserver/"; @@ -30,15 +26,15 @@ where the **documentserver** is the name of the server with the ONLYOFFICE Docum If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) it 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 sample. We will demonstrate how to run the PHP sample 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 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. * **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 Manager for IIS** (download it from the [Microsoft open source site](https://phpmanager.codeplex.com/releases/view/69115)). -## Step 4. IIS configuration +### Step 4. IIS configuration 1. **PHP Manager for IIS** configuration. @@ -81,9 +77,9 @@ You can use any web server capable of runnig PHP code to run the sample. We will After IIS manager configuration is complete, everything is ready for running the **PHP** example. -## Step 5. Running your web site with the editors +### Step 5. Run your website with the editors -1. Add your web site in the IIS Manager. +1. Add your website in the IIS Manager. On the **Connections** panel right-click the **Sites** node in the tree, then click **Add Website**. @@ -97,25 +93,27 @@ You can use any web server capable of runnig PHP code to run the sample. We will ![php-add](screenshots/php-add.png) -3. Browse your web site with the IIS manager: +3. Browse your website with the IIS manager: Right-click the site -> **Manage Website** -> **Browse** ![browse](screenshots/browse.png) -## Step 6. Checking accessibility +### 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. 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. +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. -## Running the example on Linux OS +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. -## Step 1. Download and Install Document Server +## For Linux -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE Document Server). +### 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?from=api_php_example). -## Step 2. Install the prerequisites and run the web site with the editors +### Step 2. Install the prerequisites and run the website with the editors 1. Install **Apache** and **PHP**: @@ -175,8 +173,8 @@ See the detailed guide to learn how to [install Document Server for Linux](https http://localhost/PHP%20Example/ ``` -## Step 3. Checking accessibility +### 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. 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. +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. -If you integrated the editors successfully the result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our site. \ No newline at end of file +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. diff --git a/web/documentserver-example/python/readme.md b/web/documentserver-example/python/readme.md index 5a569716..6da477a0 100644 --- a/web/documentserver-example/python/readme.md +++ b/web/documentserver-example/python/readme.md @@ -1,24 +1,20 @@ -# How to integrate online editors into your own web site on Python +## Overview -## Introduction +This example will help you integrate ONLYOFFICE Docs into your web application written in Python. -To integrate **ONLYOFFICE online editors** into your own web site on **Python** you need to download and install ONLYOFFICE editors on your local server and use the [Python Example](https://api.onlyoffice.com/editors/demopreview) for their integration. We will show how to run the Python example on Linux OS. +It is aimed at testing the editors. Please, do not use it for production without proper modifications. -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**! +## Step 1. Install ONLYOFFICE Docs -This guide will show you the sequence of actions to integrate the editors successfully. - -## Step 1. Download and Install Document Server - -First, download [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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?from=api_python_example), [for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx?from=api_python_example), or [for Docker](https://helpcenter.onlyoffice.com/server/developer-edition/docker/docker-installation.aspx?from=api_python_example). -## Step 2. Install the prerequisites and run the web site 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. -2. Download the archive with the Python example and unpack the archive: +2. Download the archive with the Python example and unpack it: ``` wget "https://api.onlyoffice.com/app_data/editor/Python%20Example.zip" @@ -71,8 +67,8 @@ See the detailed guide to learn how to install Document Server [for Windows](htt http://localhost ``` -## Step 3. Checking accessibility +## 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. 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 **exampleserver** in the configuration files. +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. -If you integrated the editors successfully the result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our site. \ No newline at end of file +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. diff --git a/web/documentserver-example/ruby/README.md b/web/documentserver-example/ruby/README.md index abeedf69..72fce465 100644 --- a/web/documentserver-example/ruby/README.md +++ b/web/documentserver-example/ruby/README.md @@ -1,20 +1,16 @@ -# How to integrate online editors into your own web site on Ruby +## Overview -## Introduction +This example will help you integrate ONLYOFFICE Docs into your web application written on Ruby. -To integrate **ONLYOFFICE online editors** into your own website on **Ruby** you need to download and install ONLYOFFICE editors on your local server and use the [Ruby Example](https://api.onlyoffice.com/editors/demopreview) for their integration. We will show how to run the Ruby example on Linux OS. +It is aimed at testing the editors. Please, do not use it for production without proper modifications. -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**! +## Step 1. Install ONLYOFFICE Docs -This guide will show you the sequence of actions to integrate the editors successfully. +Download and install ONLYOFFICE Docs (packaged as Document Server). -## Step 1. Download and Install 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), [for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx), or [for Docker](https://helpcenter.onlyoffice.com/server/developer-edition/docker/docker-installation.aspx). -First, download the [**ONLYOFFICE Editors**](https://api.onlyoffice.com/editors/demopreview) (the ONLYOFFICE 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_ruby_example), [for Linux](https://helpcenter.onlyoffice.com/installation/docs-developer-install-ubuntu.aspx?from=api_ruby_example), or [for Docker](https://helpcenter.onlyoffice.com/server/developer-edition/docker/docker-installation.aspx?from=api_ruby_example). - -## Step 2. Install the prerequisites and run the web site with the editors +## Step 2. Install the prerequisites and run the website with the editors 1. Install **Ruby Version Manager (RVM)** and the latest stable **Ruby** version: @@ -76,8 +72,8 @@ See the detailed guide to learn how to install Document Server [for Windows](htt If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *views\home\editor.html.erb* file. -## Step 3. Checking accessibility +## 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. 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. +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. -If you integrated the editors successfully the result should look like the [demo preview](https://api.onlyoffice.com/editors/demopreview#DemoPreview) on our site. \ No newline at end of file +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.