diff --git a/README.md b/README.md index 9164b0d..689cc71 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,27 @@ [![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg) [![Install OnlyOffice with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=onlyoffice) +*[Lire ce readme en français.](./README_fr.md)* + > *This package allows you to install OnlyOffice quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview + +OnlyOffice Document Server is an online office suite comprising viewers and editors for texts, spreadsheets and presentations, fully compatible with Office Open XML formats: .docx, .xlsx, .pptx and enabling collaborative editing in real time. + 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) +1. a server part, with two installation options: + 1. OnlyOffice Document Server packaged for YunoHost. + 2. 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) +2. a client part, such as: + 1. The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) + 2. 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. +The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) to install (1.ii) and (2.i) on one Nextcloud instance. However, performance and architecture are limited. -**Shipped version:** 5.2.8 +**Shipped version:** 5.6.5 ## Screenshots @@ -27,48 +32,56 @@ The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-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) + * 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 Editor](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 + +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``, 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`` + +* Assuming that: + * `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 webadmin. + * 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 other 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`` +* 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.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`` + +* Download and install a [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx). +* Start ONLYOFFICE and Go to `Connect to cloud` > `Add cloud`. + * 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! ## Documentation + * Official documentation: Link to the official documentation of this app + * YunoHost documentation: https://yunohost.org/#/app_onlyoffice + ## YunoHost specific features #### Multi-user support @@ -82,13 +95,12 @@ Prerequisite: **OnlyOffice should be public**, see previous section. * 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 + * GitHub App website: https://github.com/ONLYOFFICE/DocumentServer * YunoHost website: https://yunohost.org/ --- -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing). diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..2740786 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,112 @@ +# OnlyOffice Server pour YunoHost + +[![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg) +[![Installer OnlyOffice avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=onlyoffice) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer OnlyOffice rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* + +## Vue d'ensemble + +OnlyOffice Document Server est une suite bureautique en ligne comprenant des visualiseurs et des éditeurs de textes, feuilles de calcul et présentations, entièrement compatible avec les formats Office Open XML: .docx, .xlsx, .pptx et permettant l'édition collaborative en temps réel. + +L'édition collaborative en ligne des documents OnlyOffice nécessite : +1. une partie serveur, avec deux options d'installation : + 1. OnlyOffice Document Server packagé pour YunoHost. + 2. Le [Community Document Server pour Nextcloud](https://apps.nextcloud.com/apps/documentserver_community). + +2. une partie client, telle que : + 1. [ONLYOFFICE connector pour Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) + 2. [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) + +Les utilisateurs de Nextcloud peuvent suivre [ce tutoriel](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) pour installer le Community Document Server (1.ii) et ONLYOFFICE connector (2.i) sur une instance Nextcloud. Cependant, les performances et l'architecture sont limitées. + +**Version incluse :** 5.6.5 + +## Captures d'écran + +![](https://static-www.onlyoffice.com/v9.5.0/images/mainpage/may2018/editors/document-short.jpg) + +## Démo + +* Une démo gratuite de 30 jours de Document Server est disponible à partir du connecteur OnlyOffice pour Nextcloud: + * Installez Nextcloud et l'application ONLYOFFICE (connector). + * Allez dans les paramètres de l'administrateur Nextcloud, section ONLYOFFICE. + * Cochez la case `Connexion à la démonstration ONLYOFFICE Document Server` dans les paramètres du serveur. +* Certains tests sont également possibles en utilisant [ONLYOFFICE Desktop Editor](https://www.onlyoffice.com/fr/download-desktop.aspx). + +## Prérequis + +Vous ne devez pas installer OnlyOffice sur votre domaine YunoHost principal, surtout si vous souhaitez l'utiliser avec une instance Nextcloud installée sur le même domaine. +* Ajouter un nouveau domaine pour OnlyOffice dans YunoHost + * Si votre domaine YunoHost principal a été fourni par YunoHost, par exemple `domain.nohost.me`, alors vous n'avez pas à acheter/enregistrer un nouveau nom de domaine. + * Cliquez simplement sur `J'ai déjà un nom de domaine`. + * Tapez par exemple `office.domain.nohost.me` et cliquez sur `Ajouter`. +* Ajoutez un certificat Let's Encrypt pour ce domaine. + +## Configuration de OnlyOffice Server + +* Supposons que : + * `yunohost.domain` est votre domaine principal YunoHost. + * Vous avez configuré `office.yunohost.domain` pour OnlyOffice, voir Prérequis ci-dessus + * Vous avez Nextcloud installé sur `yunohost.domain / nextcloud` ou `nextcloud.yunohost.domain`. +* Installez `onlyoffice` à l'aide de la CLI ou de l'administrateur Web + * choisissez un nom de domaine pour OnlyOffice différent de votre domaine Nextcloud, par exemple `office.yunohost.domain` (ou `office.domain.nohost.me`, voir section précédente). + * Choisissez un chemin pour OnlyOffice, par exemple `/` si vous installez sur `office.yunohost.domain` (n'installez aucune autre application sur ce domaine). + * Le domaine de votre instance Nextcloud, par exemple `yunohost.domain / nextcloud` ou `nextcloud.yunohost.domain`. + * Est-ce une application publique ? **Si vous souhaitez le connecter à Nextcloud, OnlyOffice doit être public** : puis sélectionnez `Oui` ou `cochez la case`. + +## Comment éditer des documents OnlyOffice ? + +### Web Édition dans Nextcloud + +Prérequis : **OnlyOffice doit être public**, voir la section précédente. +* dans le magasin d'applications Nextcloud, installez `ONLYOFFICE`, c'est-à-dire le [connecteur OnlyOffice pour Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) +* Allez dans Nextcloud `Paramètres` > `Administration` > `ONLYOFFICE` > `Paramètres du serveur` > `Adresse du service d'édition de document`. +* Spécifiez le domaine d'installation de votre serveur `onlyoffice`, par exemple `https://office.yunohost.domain/` et cliquez sur `Enregistrer`. +* Créez un nouveau document ! + +### Desktop Édition sur PC + +* Téléchargez et installez [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx) +* Démarrez l'éditeur et allez dans `Connecter au Cloud` > `Ajouter cloud` + * sélectionnez ONLYOFFICE et indiquez le domaine d'installation de votre server OnlyOffice, par ex. `office.yunohost.domain` + * ou (uniquement si vous avez connecté `onlyoffice` à Nextcloud, voir section précédente). + * Sélectionnez `Nextcloud` et donnez votre domaine d'installation Nextcloud, par exemple `yunohost.domain/nextcloud`. +* Créez un nouveau document ! + +## Documentation + + * Documentation officielle : Lien vers la documentation officielle de cette application. + * Documentation YunoHost : https://yunohost.org/#/app_onlyoffice_fr + +## Caractéristiques spécifiques YunoHost + +#### Support multi-utilisateur + +#### Architectures supportées + +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/onlyoffice%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/onlyoffice/) +* 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/) + +## Liens + + * Signaler un bug : https://github.com/YunoHost-Apps/onlyoffice_ynh/issues + * Site de l'application : https://www.onlyoffice.com + * Dépôt de l'application principale : https://github.com/ONLYOFFICE/DocumentServer + * Site web YunoHost : https://yunohost.org/ + +--- + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [testing branch](https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing --debug +or +sudo yunohost app upgrade onlyoffice -u https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing --debug +``` diff --git a/issue_template.md b/issue_template.md index 90daf8e..67cd2b8 100644 --- a/issue_template.md +++ b/issue_template.md @@ -7,8 +7,8 @@ about: Create a report to help us debug, it would be nice to fill the template a **How to post a meaningful bug report** 1. *Read this whole template first.* 2. *Determine if you are on the right place:* - - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change url...), you are on the right place!* - - *Otherwise, the issue may be due to onlyoffice itself. Refer to its documentation or repository for help.* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* + - *Otherwise, the issue may be due to OnlyOffice itself. Refer to its documentation or repository for help.* - *If you have a doubt, post here, we will figure it out together.* 3. *Delete the italic comments as you write over them below, and remove this guide.* --- @@ -23,7 +23,7 @@ about: Create a report to help us debug, it would be nice to fill the template a - Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: *no / yes* - If yes, please explain: - Using, or trying to install package version/branch: -- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info onlyoffice`* **To Reproduce** *Steps to reproduce the behavior.* @@ -34,8 +34,8 @@ about: Create a report to help us debug, it would be nice to fill the template a - *If you used the webadmin, please perform the equivalent command from the CLI first.* - *If the error occurs in your browser, explain what you did:* 1. *Go to '...'* - 2. *Click on '....'* - 3. *Scroll down to '....'* + 2. *Click on '...'* + 3. *Scroll down to '...'* 4. *See error* **Expected behavior** diff --git a/manifest.json b/manifest.json index 73f8402..54fa2bf 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Create and edit documents collaboratively", "fr": "Créez et éditer des documents collaborativement" }, - "version": "5.5.3~ynh2", + "version": "5.6.5~ynh1", "url": "https://www.onlyoffice.com", "license": "GPL-3.0-or-later", "maintainer": { @@ -72,7 +72,7 @@ }, "help": { "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!" + "fr": "Nextcloud et OnlyOffice doivent être des applications publiques si vous voulez les connecter !" }, "default": true }