jaxom99/onlyoffice_ynh

OnlyOffice package for YunoHost

OnlyOffice for YunoHost

Lire ce readme en français.

This package allows you to install OnlyOffice quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide 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:

   1. ONLYOFFICE Document Server packaged for YunoHost.
   2. The Community Document Server for Nextcloud

2. a client part, such as:

   1. The ONLYOFFICE connector for Nextcloud
   2. The ONLYOFFICE Desktop Editors

A solution made easy by YunoHost is to install (1.i) and (2.i), see section below. The Nextcloud addicts may follow this tutorial to install (1.ii) and (2.i) on one Nextcloud instance. However, performance and architecture are limited.

Shipped version: 7.3.3~ynh1

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

Screenshots

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.

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.
• 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 Editors.
• 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: https://www.onlyoffice.com
• Upstream app code repository: https://github.com/ONLYOFFICE/DocumentServer
• YunoHost documentation for this app: https://yunohost.org/app_onlyoffice
• Report a bug: https://github.com/YunoHost-Apps/onlyoffice_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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

More info regarding app packaging: https://yunohost.org/packaging_apps