Git Product home page Git Product logo

haoody / onlyoffice-confluence Goto Github PK

View Code? Open in Web Editor NEW

This project forked from onlyoffice/onlyoffice-confluence

0.0 0.0 0.0 1.63 MB

The plugin which enables the users to edit office documents from Confluence using ONLYOFFICE Document Server, allows multiple users to collaborate in real time and to save back those changes to Confluence

License: GNU Affero General Public License v3.0

Java 99.63% JavaScript 0.37%

onlyoffice-confluence's Introduction

Confluence ONLYOFFICE integration plugin

This plugin enables users to edit office documents from Confluence using ONLYOFFICE Document Server. Currently the following document formats can be opened and edited with this plugin: DOCX, XLSX, PPTX.

This will create a new Edit in ONLYOFFICE action within the document library for Office documents. This allows multiple users to collaborate in real time and to save back those changes to Confluence.

Installing ONLYOFFICE Document Server

You will need an instance of ONLYOFFICE Document Server that is resolvable and connectable both from Confluence and any end clients (version 3.0 and later are supported for use with the plugin). If that is not the case, use the official ONLYOFFICE Document Server documetnations page: Document Server for Linux. ONLYOFFICE Document Server must also be able to POST to Confluence directly.

The easiest way to start an instance of ONLYOFFICE Document Server is to use Docker.

Compiling Confluence ONLYOFFICE integration plugin

You will need:

  • 1.8.X of the Oracle Java SE Development Kit 8,

  • Atlassian Plugin SDK,

  • Compile package:

atlas-package

Installing Confluence ONLYOFFICE integration plugin

Upload the compiled target/onlyoffice-confluence-plugin.jar to Confluence on the Manage add-ons page. The latest compiled package files are available here.

Configuring Confluence CONLYOFFICE integration plugin

Find the uploaded ONLYOFFICE Confluence plugin on the Manage add-ons page. Click Configure and enter the name of the server with the ONLYOFFICE Document Server installed:

http://documentserver/

How it works

The ONLYOFFICE integration follows the API documented here https://api.onlyoffice.com/editors/basic:

  • User navigates to a Confluence attachments and selects the Edit in ONLYOFFICE action.
  • Confluence makes a request to OnlyOfficeEditorServlet (URL of the form: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
  • Confluence sends document to ONLYOFFICE Document storage service and receive a temporary link.
  • Confluence prepares a JSON object with the following properties:
    • fileUrl: the temporary link that ONLYOFFICE Document Server uses to download the document,
    • callbackUrl: the URL that ONLYOFFICE Document Server informs about status of the document editing,
    • docserviceApiUrl: the URL that the client needs to reply to ONLYOFFICE Document Server (provided by the files.docservice.url.api property),
    • key: the UUID to instruct ONLYOFFICE Document Server whether to download the document again or not,
    • fileName: the document Title (name).
  • Confluence takes this object and constructs a page from a freemarker 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 Document storage and the user begins editing.
  • 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 Confluence know that the clients have finished editing the document and closed it.
  • Confluence downloads the new version of the document, replacing the old one.

ONLYOFFICE Document Server editions

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

ONLYOFFICE Document Server:

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

The table below will help you make the right choice.

Pricing and licensing Community Edition Integration 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 Integration Edition
Documentation Help Center Help Center
Standard support GitHub or paid One year support included
Premium support Buy Now Buy Now
Services Community Edition Integration Edition
Conversion Service + +
Document Builder Service + +
Interface Community Edition Integration Edition
Tabbed interface + +
White Label - -
Integrated test example (node.js) - +
Plugins & Macros Community Edition Integration Edition
Plugins + +
Macros + +
Collaborative capabilities Community Edition Integration 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 Integration Edition
Font and paragraph formatting + +
Object insertion + +
Content control + +
Layout tools + +
Table of contents + +
Navigation panel + +
Mail Merge + +
Spreadsheet Editor features Community Edition Integration Edition
Font and paragraph formatting + +
Object insertion + +
Functions, formulas, equations + +
Table templates + +
Pivot tables +* +*
Presentation Editor features Community Edition Integration Edition
Font and paragraph formatting + +
Object insertion + +
Animations + +
Presenter mode + +
Notes + +
Get it now Start Free Trial

*Changing style and deleting (Full support coming soon)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.