Skip to content

Commit

Permalink
Merge pull request #86 from YunoHost-Apps/testing
Browse files Browse the repository at this point in the history
Testing
  • Loading branch information
ericgaspar authored Apr 25, 2023
2 parents a9b5b30 + cd8fe67 commit 205cc12
Show file tree
Hide file tree
Showing 16 changed files with 270 additions and 139 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/updater.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Fetch the source code
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
- name: Run the updater script
Expand All @@ -33,7 +33,7 @@ jobs:
- name: Create Pull Request
id: cpr
if: ${{ env.PROCEED == 'true' }}
uses: peter-evans/create-pull-request@v3
uses: peter-evans/create-pull-request@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: Update to version ${{ env.VERSION }}
Expand Down
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ It shall NOT be edited by hand.

# OnlyOffice for YunoHost

[![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![Working status](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)
[![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![Working status](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)

[![Install OnlyOffice with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=onlyoffice)

*[Lire ce readme en français.](./README_fr.md)*
Expand All @@ -15,66 +16,64 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in

## 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.
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:
Online collaborative edition of ONLYOFFICE documents requires:
1. a server part, with two installation options:
1. OnlyOffice Document Server packaged for YunoHost.
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:
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.ii) and (2.i) on one Nextcloud instance. However, performance and architecture are limited.

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.1.0~ynh1

**Shipped version:** 7.3.3~ynh1

**Demo:** https://www.onlyoffice.com/fr/download-desktop.aspx

## Screenshots

![Screenshot of OnlyOffice](./doc/screenshots/.DS_Store)
![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:
* 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.
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
## 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 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).
* 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`.
* 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?
## How to edit ONLYOFFICE documents?

### Web Edition in Nextcloud

Prerequisite: **OnlyOffice should be public**, see previous section.
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`.
Expand All @@ -84,8 +83,8 @@ Prerequisite: **OnlyOffice should be public**, see previous section.

* 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 `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!

Expand Down
61 changes: 30 additions & 31 deletions README_fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,94 +5,93 @@ It shall NOT be edited by hand.

# OnlyOffice pour YunoHost

[![Niveau d'intégration](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)
[![Niveau d’intégration](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)

[![Installer OnlyOffice avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
> *Ce package vous permet dinstaller OnlyOffice rapidement et simplement sur un serveur YunoHost.
Si vous navez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment linstaller et en profiter.*

## Vue d'ensemble
## Vue densemble

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.
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 :
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.
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/blob/testing/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.

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.1.0~ynh1

**Version incluse :** 7.3.3~ynh1

**Démo :** https://www.onlyoffice.com/fr/download-desktop.aspx

## Captures d'écran
## Captures décran

![Capture d'écran de OnlyOffice](./doc/screenshots/.DS_Store)
![Capture d'écran de OnlyOffice](./doc/screenshots/document-short.png)
![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:
* 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
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
## 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 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).
* 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`.
* 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 ?
## 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)
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`.
* 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 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 : <https://www.onlyoffice.com>
* Dépôt de code officiel de l'app : <https://github.com/ONLYOFFICE/DocumentServer>
* Site officiel de lapp : <https://www.onlyoffice.com>
* Dépôt de code officiel de lapp : <https://github.com/ONLYOFFICE/DocumentServer>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_onlyoffice>
* Signaler un bug : <https://github.com/YunoHost-Apps/onlyoffice_ynh/issues>

Expand All @@ -108,4 +107,4 @@ 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 :** <https://yunohost.org/packaging_apps>
**Plus dinfos sur le packaging dapplications :** <https://yunohost.org/packaging_apps>
6 changes: 3 additions & 3 deletions check_process
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
setup_private=1
setup_public=1
upgrade=1
upgrade=1 from_commit=eca1121ff00c59325227163109d11c46bbff8e03
upgrade=1 from_commit=2be500cb4251cc1209ae36c7f0668aa17be230aa
backup_restore=1
multi_instance=0
port_already_use=0
Expand All @@ -21,6 +21,6 @@
Email=
Notification=none
;;; Upgrade options
; commit=eca1121ff00c59325227163109d11c46bbff8e03
name=Merge pull request #57 from YunoHost-Apps/testing
; commit=2be500cb4251cc1209ae36c7f0668aa17be230aa
name=Merge pull request #72 from YunoHost-Apps/testing
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666&
12 changes: 12 additions & 0 deletions conf/msg_install
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
__APP__ was successfully installed :)

Please open your __APP__ domain: https://__DOMAIN____PATH_URL__

To configure OnlyOffice with your Nextcloud, go to the settings:
under "Administration > ONLYOFFICE > Server settings >
- Address of the Document Server" enter: "https://__DOMAIN____PATH_URL__"
- Secret key" enter "__JWT_TOKEN__"

OnlyOffice should now work with your Nextcloud!

If you are facing any problem or want to improve this app, please open a new issue here: https://github.com/YunoHost-Apps/onlyoffice_ynh
5 changes: 4 additions & 1 deletion conf/nginx.conf
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
location ^~ __PATH__/ {
#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
location __PATH__/ {

proxy_pass http://127.0.0.1:__PORT__/;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
Expand All @@ -10,6 +12,7 @@ location ^~ __PATH__/ {
proxy_redirect off;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;

more_set_headers "X-Frame-Options : ALLOW-FROM https://__NEXTCLOUDDOMAIN__ always";
client_max_body_size 10M;
}
Loading

0 comments on commit 205cc12

Please sign in to comment.