From ec6ea72069affca43c38ed7b3b8afc1c0b8022c4 Mon Sep 17 00:00:00 2001 From: Natalia Date: Thu, 16 Dec 2021 17:51:01 +0300 Subject: [PATCH] small fixes for readme files --- .../csharp-mvc/README.md | 5 ++-- web/documentserver-example/csharp/README.md | 4 ++-- .../java-spring/README.md | 19 ++++++--------- web/documentserver-example/java/README.md | 24 ++++++++----------- web/documentserver-example/nodejs/README.md | 13 ++++------ web/documentserver-example/php/README.md | 9 ++++--- web/documentserver-example/python/readme.md | 5 ++-- web/documentserver-example/ruby/README.md | 6 ++--- 8 files changed, 34 insertions(+), 51 deletions(-) diff --git a/web/documentserver-example/csharp-mvc/README.md b/web/documentserver-example/csharp-mvc/README.md index 998cb267..eba2b739 100644 --- a/web/documentserver-example/csharp-mvc/README.md +++ b/web/documentserver-example/csharp-mvc/README.md @@ -13,12 +13,13 @@ 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 Download the [.Net (C# MVC) example](https://api.onlyoffice.com/editors/demopreview) from our site. -You need to connnect the editors to your website. Specify path to the editors installation in the *settings.config* file: + +To connect the editors to your website, specify the path to the editors installation and the path to the storage folder in the *settings.config* file: ``` ``` -where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. Where **storage_path** is the path where files will created and stored, you can set an absolute path. +where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **storage-path** is the path where files will be created and stored. You can set an absolute path. If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *DocEditor.aspx* file. diff --git a/web/documentserver-example/csharp/README.md b/web/documentserver-example/csharp/README.md index 305dfabb..3d5f53bb 100644 --- a/web/documentserver-example/csharp/README.md +++ b/web/documentserver-example/csharp/README.md @@ -14,12 +14,12 @@ See the detailed guide to learn how to install Document Server [for Windows](htt Download the [.Net (C#) example](https://api.onlyoffice.com/editors/demopreview) from our site. -Connect the editors to your website by specifying the path to the editors installation in the *settings.config* file: +To connect the editors to your website, specify the path to the editors installation and the path to the storage folder in the *settings.config* file: ``` ``` -where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. Where **storage_path** is the path where files will created and stored, you can set an absolute path. +where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **storage-path** is the path where files will be created and stored. You can set an absolute path. If you want to experiment with the editor configuration, modify the [parameters](https://api.onlyoffice.com/editors/advanced) in the *DocEditor.aspx* file. diff --git a/web/documentserver-example/java-spring/README.md b/web/documentserver-example/java-spring/README.md index d61ed84c..651a771b 100755 --- a/web/documentserver-example/java-spring/README.md +++ b/web/documentserver-example/java-spring/README.md @@ -19,16 +19,15 @@ See the detailed guide to learn how to install Document Server [for Windows](htt Download the [Java-Spring example](https://api.onlyoffice.com/editors/demopreview) from our site. -To connect the editors to your website, specify the path to the editors installation, server address and port in the *\src\main\resources\application.properties* file: +To connect the editors to your website, specify the path to the editors installation, server port 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 Document Server installed. -**port** is the any available port. Where **files.storage** is the path where files will created and stored(by default is the project folder), you can set an absolute path. -Note, on Windows OS use double backslash as separator. +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](https://api.onlyoffice.com/editors/advanced) it the *\src\main\resources\editor.html* file. @@ -112,8 +111,6 @@ To run the Java example code, install the Java version 11 appropriate for your O ``` http://server.address:server.port/ ``` - - ### Step 6. Check accessibility @@ -173,12 +170,12 @@ See the detailed guide to learn how to install Document Server [for Linux](https Edit 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 Document Server installed. - **port** is the any available port. Where **files.storage** is the path where files will created and stored(by default is the project folder), you can set an absolute path. + 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. 5. Install **Maven**: @@ -204,7 +201,6 @@ See the detailed guide to learn how to install Document Server [for Linux](https ``` - ### 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. @@ -222,13 +218,12 @@ Make sure that the Document Server has access to the server with the example ins 2. Edit the following lines: ``` - server.address=address + files.storage= server.port=port files.docservice.url.site=https://documentserver/ ``` - Where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. - **address** is the address of the server or comment this line to use localhost, **port** is the any available port. + 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. 3. Run the next command in the java example directory: diff --git a/web/documentserver-example/java/README.md b/web/documentserver-example/java/README.md index 7c558d68..fc28bbd4 100644 --- a/web/documentserver-example/java/README.md +++ b/web/documentserver-example/java/README.md @@ -16,16 +16,14 @@ See the detailed guide to learn how to [install Document Server for Windows](htt 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: +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\settings.properties* file: ``` storage-folder = app_data files.docservice.url.site=https://documentserver/ ``` -where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. -**storage-folder** is the path where files will created and stored, you can set an absolute path, for example **D:\\\\folder**. - Note, use double backslash as separator. +where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **storage-folder** is the path where files will be created and stored. 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](https://api.onlyoffice.com/editors/advanced) in the *\src\main\webapp\editor.jsp* file. @@ -166,20 +164,17 @@ See the detailed guide to learn how to [install Document Server for Linux](https nano src/main/resources/settings.properties ``` - Edit the following line: + Edit the following lines: ``` storage-folder = app_data files.docservice.url.site=https://documentserver/ ``` - where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. - **storage-folder** is the path where files will created and stored. - Note, you must have read and write permissions to folder. - If not, please, use next command: - ``` - sudo chmod -R ugo+rw /{path} - ``` + where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **storage-folder** is the path where files will be created and stored. Please note that you must have read and write permissions to the folder. If you do not have them, please use the next command: + ``` + sudo chmod -R ugo+rw /{path} + ``` 5. Install **Maven**: @@ -248,13 +243,14 @@ Make sure that the Document Server has access to the server with the example ins nano src/main/resources/settings.properties ``` -2. Edit the following line: +2. Edit the following lines: ``` + storage-folder = app_data 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 and the **storage-folder** is the path where files will be created and stored. 3. Run the next command in the Java example directory: diff --git a/web/documentserver-example/nodejs/README.md b/web/documentserver-example/nodejs/README.md index 1bbf0110..5590fbed 100644 --- a/web/documentserver-example/nodejs/README.md +++ b/web/documentserver-example/nodejs/README.md @@ -16,7 +16,7 @@ See the detailed guide to learn how to [install Document Server for Windows](htt Download the [Node.js example](https://api.onlyoffice.com/editors/demopreview) from our site. -You need to connect the editors to your website. Specify the path to the editors installation in the *config/default.json* file: +To connect the editors to your website, specify the path to the editors installation and the path to the storage folder in the *config/default.json* file: ``` "storageFolder": "./files" @@ -24,9 +24,7 @@ You need to connect the editors to your website. Specify the path to the editors "siteUrl": "https://documentserver/" ``` -where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. -**storageFolder** and **storagePath** is the path where files will created and stored, you can set an absolute path, for example **D:\\\\folder**. -Note, use double backslash as separator. +where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed, the **storageFolder** and **storagePath** are the paths where files will be created and stored. 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](https://api.onlyoffice.com/editors/advanced) in the *\views\editor.ejs* file. @@ -118,7 +116,7 @@ See the detailed guide to learn how to [install Document Server for Linux](https nano config/default.json ``` - Edit the following line: + Edit the following lines: ``` "storageFolder": "./files" @@ -126,10 +124,7 @@ See the detailed guide to learn how to [install Document Server for Linux](https "siteUrl": "https://documentserver/" ``` - where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. - **storageFolder** and **storagePath** is the path where files will created and stored. - Note, you must have read and write permissions to folder. - If not, please, use next command: + where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed, the **storageFolder** and **storagePath** are the paths where files will be created and stored. Please note that you must have read and write permissions to the folder. If you do not have them, please use the next command: ``` sudo chmod -R ugo+rw /{path} ``` diff --git a/web/documentserver-example/php/README.md b/web/documentserver-example/php/README.md index c8e291c3..2c676d3c 100644 --- a/web/documentserver-example/php/README.md +++ b/web/documentserver-example/php/README.md @@ -16,15 +16,14 @@ See the detailed guide to learn how to [install Document Server for Windows](htt Download the [PHP example](https://api.onlyoffice.com/editors/demopreview) from our site. -You need to connect the editors to your website. Specify the path to the editors installation in the *config.php* file: +To connect the editors to your website, specify the path to the editors installation and the path to the storage folder in the *config.php* file: ``` $GLOBALS['STORAGE_PATH'] = ""; $GLOBALS['DOC_SERV_SITE_URL'] = "https://documentserver/"; ``` -where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. Where **STORAGE_PATH** is the path where files will created and stored, you can set an absolute path, for example **D:\\\\folder**. -Note, use double backslash as separator. +where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **STORAGE_PATH** is the path where files will be created and stored. 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](https://api.onlyoffice.com/editors/advanced) in the *doceditor.php* file. @@ -149,14 +148,14 @@ See the detailed guide to learn how to [install Document Server for Linux](https nano config.php ``` - Edit the following line: + Edit the following lines: ``` $GLOBALS['STORAGE_PATH'] = ""; $GLOBALS['DOC_SERV_SITE_URL'] = "https://documentserver/"; ``` - where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. Where **STORAGE_PATH** is the path where files will created and stored, you can set an absolute path. + where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **STORAGE_PATH** is the path where files will be created and stored. You can set an absolute path. 5. Set permission for site: diff --git a/web/documentserver-example/python/readme.md b/web/documentserver-example/python/readme.md index 06f2fa9c..db08f6f3 100644 --- a/web/documentserver-example/python/readme.md +++ b/web/documentserver-example/python/readme.md @@ -45,15 +45,14 @@ See the detailed guide to learn how to install Document Server [for Windows](htt nano config.py ``` - Edit the following line: + Edit the following lines: ``` STORAGE_PATH = 'app_data' DOC_SERV_SITE_URL = 'https://documentserver/' ``` - where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. Where the **app_data** is the path where files will created and stored, you can set an absolute path. - Note, on Windows OS use double backslash as separator. + where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **STORAGE_PATH** is the path where files will be created and stored. 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. 6. Run the **Python** server: diff --git a/web/documentserver-example/ruby/README.md b/web/documentserver-example/ruby/README.md index 7280c0d1..f4d24b07 100644 --- a/web/documentserver-example/ruby/README.md +++ b/web/documentserver-example/ruby/README.md @@ -50,16 +50,14 @@ See the detailed guide to learn how to install Document Server [for Windows](htt nano config/application.rb ``` - Edit the following line: + Edit the following lines: ``` Rails.configuration.storagePath="app_data" Rails.configuration.urlSite="https://documentserver/" ``` - where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed. Where the **app_data** - is the path where files will created and stored, you can set an absolute path. - Note, on Windows OS use double backslash as separator. + where the **documentserver** is the name of the server with the ONLYOFFICE Document Server installed and the **storagePath** is the path where files will be created and stored. 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. 6. Run the **Rails** application: