From e5a064cb4de23fadf87533f07180b5f8fe861f87 Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Fri, 1 May 2020 15:34:50 +0200 Subject: [PATCH 1/9] Advise public install if nextcloud integration --- manifest.json | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/manifest.json b/manifest.json index 2a32d25..9ac1999 100644 --- a/manifest.json +++ b/manifest.json @@ -55,10 +55,14 @@ "name": "is_public", "type": "boolean", "ask": { - "en": "Is it a public application?", - "fr": "Est-ce une application publique ?" + "en": "Is it a public application? Check the box if you want to use it with Nextcloud.", + "fr": "Est-ce une application publique ? Cocher la case si vous voulez l'intégrer dans Nextcloud." }, - "default": true + "default": true, + "help": { + "en": "You will only be able to integrate OnlyOffice in Nextcloud if both apps are public.", + "fr": "Nextcloud et OnlyOffice doivent être des applications publiques si vous voulez les intégrer." + } } ] } From 29de1e8f6d1ef9bfc6262d475d63b96beddc6ad3 Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Fri, 1 May 2020 20:03:16 +0200 Subject: [PATCH 2/9] Explain server install and client config --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 62 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 024716b..414eed1 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,67 @@ -# OnlyOffice for YunoHost +# OnlyOffice Server for YunoHost [![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) [![Install OnlyOffice with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=onlyoffice) -> *This package allow you to install OnlyOffice quickly and simply on a YunoHost server. +> *This package allows you to install OnlyOffice quickly and simply on a YunoHost server. If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview -OnlyOffice Document Server +This package installs a Document Server application supporting collaborative edition of OnlyOffice documents. Edition of documents requires a Client application such as the [OnlyOffice connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) or the [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) **Shipped version:** 5.2.8 +## Screenshots + +![](Link to a screenshot for this app) + +## Demo + +* A free 30 days demo of Document Server is available from OnlyOffice connector for Nextcloud: + * Install Nextcloud and the ONLYOFFICE app (connector) + * Go in the Nextcloud administrator settings, section ONLYOFFICE + * Tick the box `Connection to demo ONLYOFFICE Document Server`` in Server Parameters +* Some testing is also possible using [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) + +## Prerequisite +You should not install ``onlyoffice`` on your main YunoHost domain, especially if you want to use it with a ``nextcloud`` installed on the same domain. +* Add a new domain for OnlyOffice in YunoHost + * If your main YunoHost domain was provided by YunoHost, e.g. ``domain.nohost.me``, then you don't have to buy/register a new domain name + * Just click on ``I already have a domain`` + * Type e.g. ``office.domain.nohost.me`` and click on ``Add`` +* Add a Let's Encrypt certificate for this domain + +## Configuration of OnlyOffice Server +* Suppose: + * ``yunohost.domain`` is your main YunoHost domain + * you have configured ``office.yunohost.domain`` for OnlyOffice, see Prerequisite above + * you have Nextcloud installed on ``yunohost.domain/nextcloud`` or ``nextcloud.yunohost.domain`` +* Install ``onlyoffice`` using CLI or web admin + * Choose a domain name for OnlyOffice that is different from your Nextcloud domain, e.g. ``office.yunohost.domain`` (or ``office.domain.nohost.me`` previously created) + * Choose a path for OnlyOffice, e.g. ``/`` if you install on ``office.yunohost.domain`` (do not install any further app on this domain) + * The domain of your Nextcloud instance, e.g. ``yunohost.domain/nextcloud`` or ``nextcloud.yunohost.domain`` + * Is it a public application? **If you want to connect it to Nextcloud, OnlyOffice should be public**: then select ``Yes`` or ``tick the box`` + +## How to edit OnlyOffice documents? +### Web Edition in Nextcloud +Prerequisite: **OnlyOffice should be public**, see previous section. +* In Nextcloud apps store, install ``ONLYOFFICE``, i.e. the [OnlyOffice connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) +* Go in the Nextcloud ``settings``>``Administration``>``ONLYOFFICE``>``Server settings``>``Address of the Document Server`` +* Give the installation domain of your ``onlyoffice``, e.g. ``https://office.yunohost.domain/`` and click ``Save`` +* Create a new document and enjoy! + +### Desktop Edition on PC +* Download and install a [ONLYOFFICE Desktop Editor](https://www.onlyoffice.com/fr/download-desktop.aspx) +* Start the Editor and Go to ``Connect to cloud``>``Add cloud`` + * Select ``ONLYOFFICE`` and give the installation domain of your ``onlyoffice``, e.g. ``office.domain.nohost.me`` + * or (only if you connected ``onlyoffice`` to Nextcloud, see previous section) + * Select ``Nextcloud`` and give your nextcloud installation domain, e.g. ``yunohost.domain/nextcloud`` +* Create a new document and enjoy! + +## Documentation + ## YunoHost specific features +#### Multi-users support #### Supported architectures @@ -19,12 +69,21 @@ OnlyOffice Document Server * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/onlyoffice%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/onlyoffice/) * Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/onlyoffice%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/onlyoffice/) +## Limitations + +* + +## Additional information + +* + ## Links * Report a bug: https://github.com/YunoHost-Apps/onlyoffice_ynh/issues * App website: https://www.onlyoffice.com * Github App website: https://github.com/ONLYOFFICE/DocumentServer * YunoHost website: https://yunohost.org/ + * YunoHost documentation: If specific documentation is needed, feel free to contribute. --- From 0be17a160a8ff82d267b8ec4a8ef6fcbc45c4dc0 Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Fri, 1 May 2020 20:07:27 +0200 Subject: [PATCH 3/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 414eed1..f5e7646 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ You should not install ``onlyoffice`` on your main YunoHost domain, especially i * you have configured ``office.yunohost.domain`` for OnlyOffice, see Prerequisite above * you have Nextcloud installed on ``yunohost.domain/nextcloud`` or ``nextcloud.yunohost.domain`` * Install ``onlyoffice`` using CLI or web admin - * Choose a domain name for OnlyOffice that is different from your Nextcloud domain, e.g. ``office.yunohost.domain`` (or ``office.domain.nohost.me`` previously created) + * Choose a domain name for OnlyOffice that is different from your Nextcloud domain, e.g. ``office.yunohost.domain`` (or ``office.domain.nohost.me``, see previous section) * Choose a path for OnlyOffice, e.g. ``/`` if you install on ``office.yunohost.domain`` (do not install any further app on this domain) * The domain of your Nextcloud instance, e.g. ``yunohost.domain/nextcloud`` or ``nextcloud.yunohost.domain`` * Is it a public application? **If you want to connect it to Nextcloud, OnlyOffice should be public**: then select ``Yes`` or ``tick the box`` @@ -53,7 +53,7 @@ Prerequisite: **OnlyOffice should be public**, see previous section. ### Desktop Edition on PC * Download and install a [ONLYOFFICE Desktop Editor](https://www.onlyoffice.com/fr/download-desktop.aspx) * Start the Editor and Go to ``Connect to cloud``>``Add cloud`` - * Select ``ONLYOFFICE`` and give the installation domain of your ``onlyoffice``, e.g. ``office.domain.nohost.me`` + * Select ``ONLYOFFICE`` and give the installation domain of your ``onlyoffice``, e.g. ``office.yunohost.domain`` * or (only if you connected ``onlyoffice`` to Nextcloud, see previous section) * Select ``Nextcloud`` and give your nextcloud installation domain, e.g. ``yunohost.domain/nextcloud`` * Create a new document and enjoy! From 867fcebf5b3fb7bc3ba84254cd8a31996cb79fae Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Fri, 1 May 2020 20:43:11 +0200 Subject: [PATCH 4/9] Propagate explanations from README to manifest --- manifest.json | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/manifest.json b/manifest.json index 9ac1999..390839f 100644 --- a/manifest.json +++ b/manifest.json @@ -29,7 +29,11 @@ "en": "Choose a domain name for OnlyOffice", "fr": "Choisissez un nom de domaine pour OnlyOffice" }, - "example": "example.com" + "example": "office.yunohost.domain", + "help": { + "en": "You should not install OnlyOffice on your main YunoHost domain, especially if you want to use it with a nextcloud installed on the same domain.", + "fr": "Evitez d'installer OnlyOffice sur votre domaine Yunohost principal, surtout si vous voulez l'utiliser avec une instance Nextcloud installée sur le même domaine." + }, }, { "name": "path", @@ -38,31 +42,38 @@ "en": "Choose a path for OnlyOffice", "fr": "Choisissez un chemin pour OnlyOffice" }, - "example": "/onlyoffice", - "default": "/onlyoffice" + "example": "/onlyoffice or /", + "help": { + "en": "If you chose a subdomain, e.g. office.yunohost.domain, then you can choose root path /.", + "fr": "Si vous avez choisi un sous-domaine, ex. office.yunohost.domain, alors vous pouvez installer sur le chemin racine /." + }, }, { "name": "nextclouddomain", "type": "string", "ask": { - "en": "The domain of your Nextcloud instance", - "fr": "Le domain de votre instance Nextcloud" + "en": "The domain of the Nextcloud to connect to OnlyOffice", + "fr": "Le domaine du Nextcloud à connecter à OnlyOffice" }, - "example": "example.com", - "default": "example.com" + "example": "yunohost.domain/nextcloud or nextcloud.yunohost.domain", + "help": { + "en": "Install the OnlyOffice connector to edit documents from Nextcloud.", + "fr": "Installez le connecteur OnlyOffice pour éditer des documents dans Nextcloud." + }, + "default": "yunohost.domain/nextcloud" }, { "name": "is_public", "type": "boolean", "ask": { - "en": "Is it a public application? Check the box if you want to use it with Nextcloud.", - "fr": "Est-ce une application publique ? Cocher la case si vous voulez l'intégrer dans Nextcloud." + "en": "Is it a public application? If you want to connect the app to Nextcloud: check/true!", + "fr": "Est-ce une application publique ? Si vous voulez connecter l'app à Nextcloud : cochez/true!" }, - "default": true, "help": { - "en": "You will only be able to integrate OnlyOffice in Nextcloud if both apps are public.", - "fr": "Nextcloud et OnlyOffice doivent être des applications publiques si vous voulez les intégrer." - } + "en": "You will only be able to connect OnlyOffice to Nextcloud if both apps are public!", + "fr": "Nextcloud et OnlyOffice doivent être des applications publiques si vous voulez les connecter!" + }, + "default": true } ] } From b7589678d9beb7072efc6cbbf484ad8654220d04 Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Fri, 1 May 2020 22:10:19 +0200 Subject: [PATCH 5/9] Update manifest.json --- manifest.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/manifest.json b/manifest.json index 390839f..81a40bf 100644 --- a/manifest.json +++ b/manifest.json @@ -33,7 +33,7 @@ "help": { "en": "You should not install OnlyOffice on your main YunoHost domain, especially if you want to use it with a nextcloud installed on the same domain.", "fr": "Evitez d'installer OnlyOffice sur votre domaine Yunohost principal, surtout si vous voulez l'utiliser avec une instance Nextcloud installée sur le même domaine." - }, + } }, { "name": "path", @@ -44,9 +44,10 @@ }, "example": "/onlyoffice or /", "help": { - "en": "If you chose a subdomain, e.g. office.yunohost.domain, then you can choose root path /.", - "fr": "Si vous avez choisi un sous-domaine, ex. office.yunohost.domain, alors vous pouvez installer sur le chemin racine /." + "en": "Root path / if you chose a subdomain, e.g. office.yunohost.domain.", + "fr": "Choisissez le chemin racine / si vous avez choisi un sous-domaine, ex. office.yunohost.domain." }, + "default": "/onlyoffice" }, { "name": "nextclouddomain", From 7af62bf60ee420ae56da8132ca22fe62cd6e9816 Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Sat, 2 May 2020 03:33:46 +0200 Subject: [PATCH 6/9] link nextcloud_ynh README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f5e7646..24bbd61 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,19 @@ [![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) [![Install OnlyOffice with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=onlyoffice) -> *This package allows you to install OnlyOffice quickly and simply on a YunoHost server. +> *This package allows you to install OnlyOffice Document Server quickly and simply on a YunoHost server. If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview -This package installs a Document Server application supporting collaborative edition of OnlyOffice documents. Edition of documents requires a Client application such as the [OnlyOffice connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) or the [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) +Online collaborative edition of OnlyOffice documents requires: +1) a server part, with two installation options: + a) **This package installs an OnlyOffice Document Server**. + b) The [Community Document Server for Nextcloud](https://apps.nextcloud.com/apps/documentserver_community) +2) a client part, such as: + a) The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) + b) The [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) + +The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) to install 1)a) and 2)a) on one Nextcloud instance. However, performance and architecture are limited. **Shipped version:** 5.2.8 From 9590366d9ff0bff3d25e9bc2859c716781ee2f1b Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Sat, 2 May 2020 03:39:03 +0200 Subject: [PATCH 7/9] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24bbd61..939883f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Online collaborative edition of OnlyOffice documents requires: a) The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) b) The [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) -The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) to install 1)a) and 2)a) on one Nextcloud instance. However, performance and architecture are limited. +The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) to install 1)b) and 2)a) on one Nextcloud instance. However, performance and architecture are limited. **Shipped version:** 5.2.8 From e652857be56330a016a1dec2507730f3ddd866c7 Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Sat, 2 May 2020 03:40:53 +0200 Subject: [PATCH 8/9] typo --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 939883f..477eb9f 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,14 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to ## Overview Online collaborative edition of OnlyOffice documents requires: 1) a server part, with two installation options: - a) **This package installs an OnlyOffice Document Server**. - b) The [Community Document Server for Nextcloud](https://apps.nextcloud.com/apps/documentserver_community) + +a) **This package installs an OnlyOffice Document Server**. +b) The [Community Document Server for Nextcloud](https://apps.nextcloud.com/apps/documentserver_community) + 2) a client part, such as: - a) The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) - b) The [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) + +a) The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) +b) The [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) to install 1)b) and 2)a) on one Nextcloud instance. However, performance and architecture are limited. From b9c1fa62c57591217ddfee1bd08fbd3f7729c050 Mon Sep 17 00:00:00 2001 From: Gredin67 <35761345+Gredin67@users.noreply.github.com> Date: Sat, 2 May 2020 03:41:37 +0200 Subject: [PATCH 9/9] typo --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 477eb9f..e88b801 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,12 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to ## Overview Online collaborative edition of OnlyOffice documents requires: 1) a server part, with two installation options: - -a) **This package installs an OnlyOffice Document Server**. -b) The [Community Document Server for Nextcloud](https://apps.nextcloud.com/apps/documentserver_community) + a) **This package installs an OnlyOffice Document Server**. + b) The [Community Document Server for Nextcloud](https://apps.nextcloud.com/apps/documentserver_community) 2) a client part, such as: - -a) The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) -b) The [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) + a) The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) + b) The [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) to install 1)b) and 2)a) on one Nextcloud instance. However, performance and architecture are limited.