diff --git a/README.md b/README.md index c10f08c..87efee6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -29,73 +29,20 @@ Online collaborative edition of ONLYOFFICE documents requires: A solution made easy by YunoHost is to install (1.i) and (2.i), see [section below](https://github.com/YunoHost-Apps/onlyoffice_ynh/#configuration-of-onlyoffice-server). 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:** 7.5~ynh1 -**Demo:** https://www.onlyoffice.com/fr/download-desktop.aspx +**Demo:** ## Screenshots ![Screenshot of OnlyOffice](./doc/screenshots/document-short.png) -## Disclaimers / important information - -## 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 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. - -## Configuration of ONLYOFFICE Server - -* 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/`. -* Give the secret key that was sent to you by email during the install (you can also retrieve it with the CLI command `sudo documentserver-jwt-status.sh`). -* Click `Save`. -* Create a new document and enjoy! - -### Desktop Edition on PC - -* 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 and resources -* Official app website: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info @@ -103,7 +50,7 @@ Please send your pull request to the [testing branch](https://github.com/YunoHos To try the testing branch, please proceed like that. -``` bash +```bash 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/README_fr.md b/README_fr.md index 2d6517c..8314715 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,5 +1,5 @@ @@ -29,73 +29,20 @@ L'édition collaborative en ligne des documents ONLYOFFICE nécessite : Une solution rendue facile par YunoHost est d'installer (1.i) et (2.i), voir [ci-dessous](https://github.com/YunoHost-Apps/onlyoffice_ynh/blob/master/README_fr.md#configuration-de-onlyoffice-server). Les utilisateurs qui aiment le tout Nextcloud peuvent suivre [ce tutoriel](https://github.com/YunoHost-Apps/nextcloud_ynh/blob/master/README_fr.md#configurer-lint%C3%A9gration-donlyoffice) 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 :** 7.5~ynh1 -**Démo :** https://www.onlyoffice.com/fr/download-desktop.aspx +**Démo :** ## Captures d’écran ![Capture d’écran de OnlyOffice](./doc/screenshots/document-short.png) -## Avertissements / informations importantes - -## 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/`. -* Renseignez la clé secrète qui vous a été envoyée par email lors de l'installation (vous pouvez aussi la retrouve avec la ligne de commande `sudo documentserver-jwt-status.sh`). -* 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 ! - ## Documentations et ressources -* Site officiel de l’app : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs @@ -103,10 +50,10 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno Pour essayer la branche testing, procédez comme suit. -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing --debug ou sudo yunohost app upgrade onlyoffice -u https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :**