diff --git a/README.md b/README.md index 4d245de..70a5d16 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,34 @@ -# Collabora for YunoHost + + +# Collabora Online for YunoHost [![Integration level](https://dash.yunohost.org/integration/collabora.svg)](https://dash.yunohost.org/appci/app/collabora) ![](https://ci-apps.yunohost.org/ci/badges/collabora.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/collabora.maintain.svg) -[![Install Collabora with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=collabora) +[![Install Collabora Online with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=collabora) -> *This package allow you to install Collabora 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.* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Collabora Online 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 -[Collabora](https://www.collaboraoffice.com/code/) is an online office suite usable with Nextcloud. +LibreOffice-based online office suite with collaborative editing + +**Shipped version:** 6.4.4~ynh1 + -**Shipped version:** 6.4.4 ## Screenshots -![](https://www.collaboraoffice.com/wp-content/uploads/2019/07/Collabora_Online_-_versions_integration.png) +![](./doc/screenshots/Collabora_Online_-_versions_integration.png) + +## Disclaimers / important information ## Configuration + **Settings:** The settings of Collabora are at `https://office.domain.tld/loleaflet/dist/admin/admin.html`. @@ -24,22 +36,11 @@ The settings of Collabora are at `https://office.domain.tld/loleaflet/dist/admin - Password: The password set during the installation. (If you forgot it, you can find it again in `/etc/loolwsd/loolwsd.xml`). ## Connexion to Nextcloud + If you want to connect with Nextcloud, you have to install the [Collabora Online](https://apps.nextcloud.com/apps/richdocuments) app in Nextcloud, and configure it with the domain of your Collabora installation. *:warning: There are several Collabora Online apps. Be sure **not** to install the `Collabora Online - Built-in CODE server` apps, which are a lightwheigt version of this Collabora package. :warning:* -## Documentation - - * Official documentation: https://www.collaboraoffice.com/code/ - * YunoHost documentation: https://yunohost.org/#/app_collabora - -#### Multi-users support - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/collabora%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/collabora/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/collabora%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/collabora/) - ## Limitations **ARM platform not supported.** If you want to run Collabora on Nextcloud, there is a lightweight version of the Collabora server for ARM, called [Collabora Online - Built-in CODE Server (ARM64)](https://apps.nextcloud.com/apps/richdocumentscode_arm64) which can easily connect with the [Collabora Online](https://apps.nextcloud.com/apps/richdocuments) app. @@ -53,17 +54,17 @@ If you want to connect with Nextcloud, you have to install the [Collabora Online **Upgrade this package:** You can use your YunoHost admin interface, or the command line: `sudo yunohost app upgrade collabora -u https://github.com/YunoHost-Apps/collabora_ynh --debug` -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/collabora_ynh/issues - * Collabora website: https://www.collaboraoffice.com/ - * YunoHost website: https://yunohost.org/ +* Official app website: https://collaboraoffice.com +* Official user documentation: https://yunohost.org/#/app_collabora +* Official admin documentation: https://www.collaboraoffice.com/code/ +* YunoHost documentation for this app: https://yunohost.org/app_collabora +* Report a bug: https://github.com/YunoHost-Apps/collabora_ynh/issues ---- +## Developer info -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/collabora_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/collabora_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -71,3 +72,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/collabora_ynh/tree/te or sudo yunohost app upgrade collabora -u https://github.com/YunoHost-Apps/collabora_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..88bb451 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,72 @@ +# Collabora Online pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/collabora.svg)](https://dash.yunohost.org/appci/app/collabora) ![](https://ci-apps.yunohost.org/ci/badges/collabora.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/collabora.maintain.svg) +[![Installer Collabora Online avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=collabora) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Collabora Online 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.* + +## Vue d'ensemble + +Suite office en ligne et collaborative, basée sur LibreOffice + +**Version incluse :** 6.4.4~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/Collabora_Online_-_versions_integration.png) + +## Avertissements / informations importantes + +## Configuration + +**Settings:** +The settings of Collabora are at `https://office.domain.tld/loleaflet/dist/admin/admin.html`. + +- User: admin +- Password: The password set during the installation. (If you forgot it, you can find it again in `/etc/loolwsd/loolwsd.xml`). + +## Connexion to Nextcloud + +If you want to connect with Nextcloud, you have to install the [Collabora Online](https://apps.nextcloud.com/apps/richdocuments) app in Nextcloud, and configure it with the domain of your Collabora installation. + +*:warning: There are several Collabora Online apps. Be sure **not** to install the `Collabora Online - Built-in CODE server` apps, which are a lightwheigt version of this Collabora package. :warning:* + +## Limitations + +**ARM platform not supported.** If you want to run Collabora on Nextcloud, there is a lightweight version of the Collabora server for ARM, called [Collabora Online - Built-in CODE Server (ARM64)](https://apps.nextcloud.com/apps/richdocumentscode_arm64) which can easily connect with the [Collabora Online](https://apps.nextcloud.com/apps/richdocuments) app. + +**CODE has a warning limitation** + +![](https://www.libreoffice.org/assets/Uploads/LibreOffice-Online-limit.png) + +## Additionnal informations + +**Upgrade this package:** +You can use your YunoHost admin interface, or the command line: `sudo yunohost app upgrade collabora -u https://github.com/YunoHost-Apps/collabora_ynh --debug` + +## Documentations et ressources + +* Site officiel de l'app : https://collaboraoffice.com +* Documentation officielle utilisateur : https://yunohost.org/#/app_collabora +* Documentation officielle de l'admin : https://www.collaboraoffice.com/code/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_collabora +* Signaler un bug : https://github.com/YunoHost-Apps/collabora_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/collabora_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/collabora_ynh/tree/testing --debug +ou +sudo yunohost app upgrade collabora -u https://github.com/YunoHost-Apps/collabora_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file