Skip to main content

Plone ONLYOFFICE integration plugin

Project description

Plone ONLYOFFICE integration plugin

This plugin allows users to edit office documents within Plone using ONLYOFFICE Docs packaged as Document Server - Community or Enterprise Edition.

Features

The plugin allows to:

  • Create and edit text documents, spreadsheets, and presentations.
  • Share documents with other users.
  • Co-edit documents in real-time: use two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat.

Supported formats:

  • For viewing and editing: DOCX, XLSX, PPTX.
  • For viewing only: PDF, ODT, ODS, ODP, DOC, XLS, PPT.

Installing ONLYOFFICE Docs

You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Plone and any end-clients. ONLYOFFICE Document Server must also be able to POST to Plone directly.

You can install free Community version of ONLYOFFICE Docs or scalable Enterprise Edition with pro features.

To install free Community version, use Docker (recommended) or follow these instructions for Debian, Ubuntu, or derivatives.

To install Enterprise Edition, follow instructions here.

Community Edition vs Enterprise Edition comparison can be found here.

Installing Plone ONLYOFFICE integration plugin

  1. Install plugin by adding it to your buildout.cfg:
    [buildout]
    
    ...
    
    eggs =
        onlyoffice.connector
    
  2. Run bin/buildout.
  3. Go to Site Setup -> Add-onsand press the Install button to enable plugin.

You could also install plugin via Docker

docker run --rm -p 8080:8080 -e ADDONS="onlyoffice.connector" plone

Both options will automatically install plugin from PyPi.

Configuring Plone ONLYOFFICE integration plugin

To configure plugin go to Site Setup. Scroll down to Add-ons Configuration section and press the ONLYOFFICE Configuration button.

Developing Plone ONLYOFFICE plugin

  1. Clone repository and change directory:
    git clone --branch deploy git@github.com:ONLYOFFICE/onlyoffice-plone.git
    cd onlyoffice-plone
    
  2. Create a virtualenv in the package.
  3. Install requirements with pip.
  4. Run buildout:
    virtualenv .
    ./bin/pip install -r requirements.txt
    ./bin/buildout
    
  5. Start Plone in foreground:
    ./bin/instance fg
    

If you have a working Plone instance, you can install plugin by adding the project files to the src directory:

  1. In the src directory create the onlyoffice.connector directory.
  2. Put your project files received by git into the onlyoffice.connector directory.
  3. Edit the buildout.cfg file:
    [buildout]
    
    ...
    
    eggs =
        onlyoffice.connector
    
    develop =
       src/onlyoffice.connector
    
  4. Rerun buildout for the changes to take effect:
    ./bin/buildout
    
  5. Then start or restart your Plone instance.

Note that Plone is based on Zope server and will not run as root user. If you intend to run it as root user. You must supply effective-user directive. In order to do so add effective-user <username> line to ./parts/instance/etc/zope.conf.

Upgrade Plone ONLYOFFICE integration plugin

  1. If you specified a concrete plugin version in your buildout.cfg file (so-called “pinning”, and a recommended practice), like onlyoffice.connector = 1.0.0, update this reference to point to the newer version. If the plugin version is not specified, then the latest version will be automatically loaded:
    [versions]
    
     ...
    
    onlyoffice.connector = 1.0.1
    
  2. Run bin/buildout. Wait until the new version is downloaded and installed.
  3. Restart Plone - your site may look weird, or even be inaccessible until you have performed the next step.
  4. Navigate to the Add-on screen (add /prefs_install_products_form to your site URL) and in the Upgrades list select onlyoffice.connector and click "Upgrade onlyoffice.connector".

How it works

The ONLYOFFICE integration follows the API documented here:

  • User navigates to a document within Plone and selects the ONLYOFFICE Edit action.
  • Plone prepares a JSON object for the Document Server with the following properties:
    • url: the URL that ONLYOFFICE Document Server uses to download the document;
    • callbackUrl: the URL that ONLYOFFICE Document Server informs about status of the document editing;
    • key: the UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not;
    • title: the document Title (name).
  • Plone constructs a page from a .pt template, filling in all of those values so that the client browser can load up the editor.
  • The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the docEditor configuration with the above properties.
  • Then ONLYOFFICE Document Server downloads the document from Plone and the user begins editing.
  • ONLYOFFICE Document Server sends a POST request to the callback URL to inform Plone that a user is editing the document.
  • When all users and client browsers are done with editing, they close the editing window.
  • After 10 seconds of inactivity, ONLYOFFICE Document Server sends a POST to the callback URL letting Plone know that the clients have finished editing the document and closed it.
  • Plone downloads the new version of the document, replacing the old one.

ONLYOFFICE Docs editions

ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.

  • Community Edition (onlyoffice-documentserver package)
  • Enterprise Edition (onlyoffice-documentserver-ie package)

The table below will help you make the right choice.

Pricing and licensing Community Edition Enterprise Edition
Get it now Start Free Trial
Cost FREE Go to the pricing page
Simultaneous connections up to 20 maximum As in chosen pricing plan
Number of users up to 20 recommended As in chosen pricing plan
License GNU AGPL v.3 Proprietary
Support Community Edition Enterprise Edition
Documentation Help Center Help Center
Standard support GitHub or paid One year support included
Premium support Buy Now Buy Now
Services Community Edition Enterprise Edition
Conversion Service + +
Document Builder Service + +
Interface Community Edition Enterprise Edition
Tabbed interface + +
White Label - -
Integrated test example (node.js) - +
Plugins & Macros Community Edition Enterprise Edition
Plugins + +
Macros + +
Collaborative capabilities Community Edition Enterprise Edition
Two co-editing modes + +
Comments + +
Built-in chat + +
Review and tracking changes + +
Display modes of tracking changes + +
Version history + +
Document Editor features Community Edition Enterprise Edition
Font and paragraph formatting + +
Object insertion + +
Adding Content control - +
Editing Content control + +
Layout tools + +
Table of contents + +
Navigation panel + +
Comparing Documents - +*
Spreadsheet Editor features Community Edition Enterprise Edition
Font and paragraph formatting + +
Object insertion + +
Functions, formulas, equations + +
Table templates + +
Pivot tables + +
Conditional formatting for viewing +** +**
Sheet views - +
Presentation Editor features Community Edition Enterprise Edition
Font and paragraph formatting + +
Object insertion + +
Animations + +
Presenter mode + +
Notes + +
Get it now Start Free Trial

* It's possible to add documents for comparison from your local drive and from URL. Adding files for comparison from storage is not available yet.

** Support for all conditions and gradient. Adding/Editing capabilities are coming soon

Authors

Change Log

2.0.0

Added

  • JWT support

Fixed

  • Issue when files inside unpublished folders couldn't be edited

1.0.0

Added

  • Edit option for DOCX, XLSX, PPTX.
  • View template for documents
  • Configuration page
  • Translations for BR, CZ, DE, EN, ES, FR, IT, JP, NL, RU, ZH

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for onlyoffice.connector, version 2.0.0
Filename, size File type Python version Upload date Hashes
Filename, size onlyoffice.connector-2.0.0.tar.gz (27.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page