Giter VIP home page Giter VIP logo

onlyoffice / onlyoffice-confluence Goto Github PK

View Code? Open in Web Editor NEW
37.0 17.0 29.0 3.49 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: Apache License 2.0

Java 84.35% JavaScript 11.91% CSS 3.06% Closure Templates 0.67%
onlyoffice confluence integration

onlyoffice-confluence's Introduction

Confluence ONLYOFFICE integration app

This app enables users to edit office documents from Confluence using ONLYOFFICE Docs packaged as Document Server - Community or Enterprise Edition.

Features

The app 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:

  • WORD: DJVU, DOC, DOCM, DOCX, DOCXF, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTM, HTML, MHT, ODT, OFORM, OTT, OXPS, PDF, RTF, TXT, XML, XPS
  • CELL: CSV, FODS, ODS, OTS, XLS, XLSM, XLSX, XLT, XLTM, XLTX
  • SLIDE: FODP, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, PPTX

For editing:

  • WORD: DOCM, DOCX, DOCXF, DOTM, DOTX, HTM, XML
  • CELL: XLSM, XLSX, XLTM, XLTX
  • SLIDE: POTM, POTX, PPSM, PPSX, PPTM, PPTX

For editing with possible loss of information:

  • WORD: EPUB, FB2, HTML, ODT, OTT, RTF, TXT
  • CELL: CSV, ODS, OTS
  • SLIDE: ODP, OTP

For filling:

  • WORD: OFORM

For converting to Office Open XML formats:

  • WORD: DOC, DOCM, DOCXF, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTM, HTML, MHT, ODT, OTT, OXPS, PDF, RTF, XML, XPS
  • CELL: FODS, ODS, OTS, XLS, XLSM, XLT, XLTM, XLTX
  • SLIDE: FODP, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM

Installing ONLYOFFICE Docs

You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Confluence and any end clients. ONLYOFFICE Document Server must also be able to POST to Confluence 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 Confluence ONLYOFFICE integration app

Upload the compiled target/onlyoffice-confluence-plugin.jar to Confluence on the Manage add-ons page.

The latest compiled package files are available here and on Atlassian Marketplace.

You could also install the app from Confluence administration panel:

  1. Navigate to Manage add-ons page.
  2. Click Find new apps or Find new add-ons on the left panel.
  3. Locate ONLYOFFICE Connector for Confluence using search.
  4. Click Install to download and install the app.

Configuring Confluence ONLYOFFICE integration app

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

http://documentserver/

Starting from version 7.2, JWT is enabled by default and the secret key is generated automatically to restrict the access to ONLYOFFICE Docs and for security reasons and data integrity. Specify your own Secret key on the Confluence administration page. In the ONLYOFFICE Docs config file, specify the same secret key and enable the validation.

Compiling Confluence ONLYOFFICE integration app

You will need:

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

  • Atlassian Plugin SDK,

  • Get a submodule:

    git submodule update --init --recursive
  • Compile package:

    atlas-package

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:
    • url: 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,
    • title: 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 Docs editions

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

ONLYOFFICE Docs packaged as Document Server:

  • Community Edition (onlyoffice-documentserver package)
  • Enterprise Edition (onlyoffice-documentserver-ee 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 Contact us Contact us
Services Community Edition Enterprise Edition
Conversion Service + +
Document Builder Service + +
Interface Community Edition Enterprise Edition
Tabbed interface + +
Dark theme + +
125%, 150%, 175%, 200% scaling + +
White Label - -
Integrated test example (node.js) + +
Mobile web editors - +*
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 + +
Mail Merge + +
Comparing Documents + +
Spreadsheet Editor features Community Edition Enterprise Edition
Font and paragraph formatting + +
Object insertion + +
Functions, formulas, equations + +
Table templates + +
Pivot tables + +
Data validation + +
Conditional formatting + +
Sparklines + +
Sheet Views + +
Presentation Editor features Community Edition Enterprise Edition
Font and paragraph formatting + +
Object insertion + +
Transitions + +
Animations + +
Presenter mode + +
Notes + +
Form creator features Community Edition Enterprise Edition
Adding form fields + +
Form preview + +
Saving as PDF + +
Working with PDF Community Edition Enterprise Edition
Text annotations (highlight, underline, cross out) + +
Comments + +
Freehand drawings + +
Form filling + +
Get it now Start Free Trial

* If supported by DMS.

onlyoffice-confluence's People

Contributors

aleksandrfedorov97 avatar alexeybannov avatar dependabot[bot] avatar eloncase avatar fuchsia74 avatar hellonadya avatar kseniafedoruk avatar linneys avatar lumos0 avatar maria-sukhova avatar nsenz avatar svetlana81 avatar z7g avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

onlyoffice-confluence's Issues

"Edit on Only Office" not showing

Hello,

we recently tested a new confluence version and installed the add-on, we setup a document editor server and it worked.
Confluence Version 6.7.2

Now we deployed a new confluence appliance, installed the add-on and no attachment is showing the "Edit in Only Office" context.

Confluence is the same Version as in the lab scenario and the add-on is loaded and active. it's just showing it's outdated but that was also showing in the lab setup - but it worked.
Is there anything that we might have done to disable this add-on? Or is there a log to lookup a possible error?

Kind regards,

Max

atlas-package error: Found a type annotated as a component, but the type is not a concrete class. NOT adding to index file!!

`C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master>atlas-package
Executing: "C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\apache-maven-3.2.1\bin\mvn.bat" package -gs C:\Applications\Atlassian\atlassian-plugin-sdk-6.2.9\apache-maven-3.2.1/conf/settings.xml
Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=256M; support was removed in 8.0
[INFO] Scanning for projects...
[INFO]
[INFO] Using the builder org.apache.maven.lifecycle.internal.builder.singlethreaded.SingleThreadedBuilder with a thread count of 1
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building ONLYOFFICE Confluence plugin 1.0.0
[INFO] ------------------------------------------------------------------------
[WARNING] The POM for com.atlassian.analytics:analytics-api:jar:5.0.2-hashfix is missing, no dependency information available
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:compress-resources (default-compress-resources) @ onlyoffice-confluence-plugin ---
[WARNING] File encoding has not been set, using platform encoding GBK, i.e. build is platform dependent!
[INFO] Compiling javascript using YUI
[INFO] 0 Javascript file(s) were minified into target directory C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master\target\classes
[INFO] 0 CSS file(s) were minified into target directory C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master\target\classes
[INFO] Compressing XML files
[INFO] 0 XML file(s) were minified into target directory C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master\target\classes
[INFO]
[INFO] --- maven-resources-plugin:3.0.1:resources (default-resources) @ onlyoffice-confluence-plugin ---
[WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 15 resources
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:filter-plugin-descriptor (default-filter-plugin-descriptor) @ onlyoffice-confluence-plugin ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO]
[INFO] --- maven-compiler-plugin:3.5.1:compile (default-compile) @ onlyoffice-confluence-plugin ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:generate-rest-docs (default-generate-rest-docs) @ onlyoffice-confluence-plugin ---
[INFO]
[INFO] --- atlassian-spring-scanner-maven-plugin:1.2.6:atlassian-spring-scanner (default) @ onlyoffice-confluence-plugin ---
[INFO] Starting Atlassian Spring Byte Code Scanner...
[INFO]
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.imports.RefappImport] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.imports.JiraImport] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.imports.ConfluenceImport] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.export.ModuleType] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.component.RefappComponent] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.component.JiraComponent] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.component.ConfluenceComponent] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[ERROR] Found a type [com.atlassian.plugin.spring.scanner.annotation.component.ClasspathComponent] annotated as a component, but the type is not a concrete class. NOT adding to index file!!
[INFO]
[INFO] Analysis ran in 530 ms.
[INFO] Encountered 41 total classes
[INFO] Processed 0 annotated classes
[INFO]
[INFO] --- maven-resources-plugin:3.0.1:testResources (default-testResources) @ onlyoffice-confluence-plugin ---
[WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master\src\test\resources
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:filter-test-plugin-descriptor (default-filter-test-plugin-descriptor) @ onlyoffice-confluence-plugin ---
[INFO]
[INFO] --- maven-compiler-plugin:3.5.1:testCompile (default-testCompile) @ onlyoffice-confluence-plugin ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:unit-test (default-unit-test) @ onlyoffice-confluence-plugin ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:copy-bundled-dependencies (default-copy-bundled-dependencies) @ onlyoffice-confluence-plugin ---
[INFO] atlassian-spring-scanner-runtime-1.2.6.jar already exists in destination.
[INFO] atlassian-spring-scanner-annotation-1.2.6.jar already exists in destination.
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:copy-test-bundled-dependencies (default-copy-test-bundled-dependencies) @ onlyoffice-confluence-plugin ---
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:generate-manifest (default-generate-manifest) @ onlyoffice-confluence-plugin ---
[INFO] Generating a manifest for this plugin
[INFO] using maven-bundle-plugin v2.5.3
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:generate-test-manifest (default-generate-test-manifest) @ onlyoffice-confluence-plugin ---
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:validate-manifest (default-validate-manifest) @ onlyoffice-confluence-plugin ---
[INFO] Manifest found, validating...
[WARNING] The manifest should contain versions for all imports to prevent ambiguity at install time due to multiple versions of a package. Here are some suggestions for the maven-confluence-plugin configuration generated for this project to start from:



org.springframework.context.annotation;version="0.0.0",
org.springframework.beans;version="0.0.0",
org.w3c.dom;version="0.0.0",
javax.servlet.http;version="0.0.0",
com.atlassian.confluence.;version="0.0.0",
com.atlassian.spring.container;version="0.0.0",
com.google.common.
;version="0.0.0",
org.apache.commons.;version="0.0.0",
org.eclipse.gemini.blueprint.service.
;version="0.0.0",
javax.xml.parsers;version="0.0.0",
org.osgi.util.tracker;version="0.0.0",
org.osgi.framework;version="0.0.0",
javax.servlet;version="0.0.0",
org.json;version="0.0.0",
org.springframework.osgi.service.;version="0.0.0",
org.springframework.stereotype;version="0.0.0",
org.xml.sax;version="0.0.0",
org.springframework.beans.factory
;version="0.0.0",
com.atlassian.user;version="0.0.0",
org.springframework.util;version="0.0.0",
com.atlassian.plugin.*;version="0.0.0",
org.apache.log4j;version="0.0.0",
com.atlassian.plugin;version="0.0.0"



You may notice many packages you weren't expecting. This is usually because of a bundled jar that references packages that don't apply. You can usually remove these or if necessary, mark them as optional by adding ';resolution:=optional' to the package import. Packages that are detected as version '0.0.0' usually mean either they are JDK packages or ones that aren't referenced in your project, and therefore, likely candidates for removal entirely.
[INFO] Manifest validated
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:jar (default-jar) @ onlyoffice-confluence-plugin ---
[INFO] Building jar: C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master\target\onlyoffice-confluence-plugin-1.0.0.jar
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:generate-obr-artifact (default-generate-obr-artifact) @ onlyoffice-confluence-plugin ---
[INFO] using maven-bundle-plugin v2.5.3
[INFO] Installing onlyoffice-confluence-plugin-1.0.0.jar
[INFO] Writing OBR metadata
[INFO] Building jar: C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master\target\onlyoffice-confluence-plugin-1.0.0.obr
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:validate-test-manifest (default-validate-test-manifest) @ onlyoffice-confluence-plugin ---
[INFO]
[INFO] --- maven-confluence-plugin:6.2.1:test-jar (default-test-jar) @ onlyoffice-confluence-plugin ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 27.218 s
[INFO] Finished at: 2016-10-20T10:20:22+08:00
[INFO] Final Memory: 32M/90M
[INFO] ------------------------------------------------------------------------
C:\Users\xuehaoyuan\Downloads\onlyoffice-confluence-master>

`

Plugin broken on Confluence 7.13.0

Atlassian recently updated Confluence to LTS version 7.13.0 due to security issues. Currently we cannot use ONLYOffice from Confluence as the plugin version 3.0.0 only works with Confluence 7.12. An update will be very welcome.

I tried to simply change the max Confluence and plugin version in the sources and recompiled it but cannot install the jar file. Maybe due to changes in the API.

Better integration of OnlyOffice in Confluence UI

The OnlyOffice in Confluence way is very very good but the usability is not optimal. The way to edit an file with OnlyOffice in Confluence is to complicated. It hast to be more straight forward to start edit direct from the Confluence front page where the office file is place inside the Confleunce page as link or icon. To go in attachment area and click the OnlyOffice button is not intuitive. Thank you. Best Tim Herrmann

Cannot use it with Secret

I've installed the OnlyOffice DocumentServer Version 5.0.4.15 and OnlyOffice Confluence Plugin Version 1.1.0 on Confluence 6.4.2

This is the way I create the Confluence plugin

$ git clone https://github.com/ONLYOFFICE/onlyoffice-confluence
Changed the properties in src/main/resources/onlyoffice-config.properties

files.docservice.secret=secret

$ atlas-package

Then I installed the plugin by uploading it into Confluence
I configured the plugin in Manage add-ons

If I try to edit a document Confluence opens a new tab in my browser and connects to the my document server, then I got the following error message.

Java.lang.Exception: Error occured in the Convertservice: Error document VKey

If I turn off the Secret Usage on my Document Server everything works. I will use the Secret because I don't want that everybody can use my Document Server.

Incorrect editor address when creating “new document ” on confluence attachment page

same as https://forum.onlyoffice.com/t/incorrect-editor-address-when-creating-new-document-on-confluence-attachment-page/7138

when creating "new document " on confluence attachment page,

image

click √, the browser will open this url in a new tab,

https://conf.com/plugins/servlet/onlyoffice/?attachmentId=xxxxxxx
the new tab page shows “page not found” , it seems because missing “doceditor” in url . the new tab url should be

https://conf.com/plugins/servlet/onlyoffice/doceditor?attachmentId=xxxxxxx
Document Server version: 7.5.1
Connector version: 4.4
DMS (platform) version: confluence 7.13

Required slash for editor url

Without a slash (/) after the editors URL nothing is working, which is not convenient. Please, change this behavior

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.