Project

General

Profile

Plugins Directory » Redmine ONLYOFFICE integration plugin

Author: Ascensio System SIA
Website: https://github.com/ONLYOFFICE/onlyoffice-redmine
Code repository: https://github.com/ONLYOFFICE/onlyoffice-redmine
Registered on: 2021-11-03 (over 2 years ago)
Current version: 3.0.1
Compatible with: Redmine 5.0.x, 4.2.x
User ratings:   (0)

This plugin enables users to edit attachments from Redmine using ONLYOFFICE Docs packaged as Document Server — Community or Enterprise Edition.

Features

- Viewing and editing text documents, spreadsheets, presentations, and forms.
- Co-editing documents in real time using two co-editing modes (Fast and Strict), Track Changes, comments, built-in chat.
- Settings page to set up connection to the server and JWT authentication, customize the editor's appearance.
- Mobile view for licensed editors.
- Creating new attachments using templates that consider the user's language preference.
- Converting attachments and saving or downloading them.

Supported formats

djvu doc docm docx docxf dot dotm dotx epub* fb2* fodt htm html* mht mhtml odt* oform ott* oxps pdf rtf* stw sxw txt* wps wpt xml xps csv* et ett fods ods* ots* sxc xls xlsb xlsm xlsx xlt xltm xltx dps dpt fodp odp* otp* pot potm potx pps ppsm ppsx ppt pptm pptx sxi
View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Edit - - + + + - + + + + - - + - - + + + - - + - - + - - - - + - - - + + - - - + + - + + - - - + + - + + - + + - + + -
Create - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - + -
  • To be able to open the format for editing, check it in the [formats settings](#formats). Due to some format restrictions, data loss may occur.

Configuring Redmine ONLYOFFICE Integration Plugin

General Settings

  • Document Editing Service address.
    The URL of the installed ONLYOFFICE Docs (Document Server). Leave blank to disable the plugin.

Advanced Server Settings

  • ONLYOFFICE Docs address for internal requests from the server.
  • Server address for internal requests from ONLYOFFICE Docs.
  • Connect to the demo ONLYOFFICE Docs server.

Security

  • Secret key.
    Starting from ONLYOFFICE Document Server 7.2, JWT authentication 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 secret key in the ONLYOFFICE Docs config file https://api.onlyoffice.com/editors/signature/, then specify the same key in the settings page of the plugin. Leave blank to disable authentication.
  • Authorization header.
  • Disable certificate verification (insecure).

Editor customization settings

  • Display Chat menu button.
  • Display the header more compact.
  • Display Feedback & Support menu button.
  • Display Help menu button.
  • Display monochrome toolbar header.

Formats

  • Specify the list of formats allowed to be opened directly for editing.

Installation notes

Installing ONLYOFFICE Docs

Before you proceed to the plugin installation, make sure you have an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Redmine and any end clients. Additionally, ensure that ONLYOFFICE Docs can directly POST to Redmine.

ONLYOFFICE Docs has the free Community version and scalable Enterprise Edition.

We recommend using Docker https://github.com/onlyoffice/Docker-DocumentServer to install the free Community version. Alternatively, you can follow these instructions https://helpcenter.onlyoffice.com/installation/docs-community-install-ubuntu.aspx for Debian, Ubuntu, or derivatives.

To install Enterprise Edition, follow these instructions https://helpcenter.onlyoffice.com/installation/docs-enterprise-index.aspx.

Installing Redmine ONLYOFFICE Integration Plugin

To install the plugin, you will need Redmine version 4.2 or higher, or version 5.0 or higher. It is also important to note that the plugin is compatible with Ruby version 2.7.2 or higher, or 3.0.0 or higher. We recommend using Redmine 5 along with Ruby 3.

Once you have installed Redmine, download the plugin https://github.com/ONLYOFFICE/onlyoffice-redmine/releases.
curl --location https://github.com/ONLYOFFICE/onlyoffice-redmine/releases/latest/download/onlyoffice_redmine.tar.zst --output onlyoffice_redmine.tar.zst

Unzip it into the plugins directory.
tar --extract --file onlyoffice_redmine.tar.zst --directory plugins

Install the dependencies of the plugin if Redmine did not do it automatically.
bundle install

Perform the migration.
RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=onlyoffice_redmine

And finally, restart Redmine. Read more about the plugin installation on the Redmine Wiki page https://www.redmine.org/projects/redmine/wiki/Plugins#Installing-a-plugin.

Changelog

3.0.1 (2024-02-06)

Compatible with Redmine 5.0.x, 4.2.x.

Bug Fixes

  • Support for the Document Server URL with virtual path.
  • Support for the Redmine "Authentication Required" setting.
onlyoffice_redmine.tar.zst (313 KB) onlyoffice_redmine.tar.zst Ascensio System SIA, 2024-02-06 13:56

3.0.0 (2024-01-24)

Compatible with Redmine 5.0.x, 4.2.x.

Breaking Changes

  • Support for Redmine versions below 4.2 has been dropped.
  • Support for Internet Explorer (IE) has been dropped.
  • The ability to create a document (not an attachment) has been removed.
  • Migration from Ruby version 2 to 3 has been implemented.
  • Users can now edit an attachment even if the issue is closed.
  • Support for new formats has been added.
  • User permissions have been improved for more accurate functionality.

Features

  • Added support for Redmine located in a subdirectory.
  • Replaced icons with more intuitive ones.
  • Changed the conversation from synchronous to asynchronous.
  • Added a dedicated page for the "Create in" action.
  • Users can now change the name and add a description when creating an attachment.
  • Added support for the user's language preferences when creating an attachment.
  • Combined the "Save as" and "Download as" actions onto one page.
  • Added the ability to add a description when converting a attachment.
  • Users can now select from available formats for editing.
  • Added the ability to view, edit, and convert attachments on the forums page.
  • Added the ability to edit and convert attachments on the files page.

Bug Fixes

  • Fixed the issue of settings not being saved even if validation fails.
  • Implemented a native file-saving process and fixed filename issues containing underscores.

Chores

  • Added ONLYOFFICE Docs Cloud banner on the settings page of the plugin.
  • Fixed formatting issues and ensured codebase uniformity.
  • Updated the appearance of the settings page of the plugin.
  • Updated README.
onlyoffice_redmine.tar.zst (314 KB) onlyoffice_redmine.tar.zst Ascensio System SIA, 2024-01-24 15:35

2.1.0 (2023-04-05)

Compatible with Redmine 5.0.x, 4.2.x.

Added

  • jwt header configuration
onlyoffice_redmine.zip (533 KB) onlyoffice_redmine.zip onlyoffice-redmine-2.1.0 Ascensio System SIA, 2023-04-05 14:54

2.0.0 (2022-11-24)

Compatible with Redmine 5.0.x, 4.2.x, 4.1.x, 4.0.x.

Added
  • documents conversion
  • Added connection to a demo document server
  • Document Editing Service address is now separated into two settings: inner address (address that confluence will use to access service) and public address (address that user will use to access editors)
  • validation of server settings on the settings page
  • ignoring self signed certificate
Fixed
  • issue with permissions
onlyoffice_redmine.zip (531 KB) onlyoffice_redmine.zip onlyoffice-redmine-2.0.0 Ascensio System SIA, 2022-11-24 14:09

1.1.0 (2022-01-18)

Compatible with Redmine 5.0.x, 4.2.x, 4.1.x, 4.0.x.

Added
  • ability to create documents
  • support docxf and oform formats
  • create blank docxf from creation menu
  • "save as" in editor
onlyoffice-redmine.zip (499 KB) onlyoffice-redmine.zip onlyoffice-redmine-1.1.0 Ascensio System SIA, 2022-01-18 12:56

1.0.0 (2021-11-03)

Compatible with Redmine 5.0.x, 4.2.x, 4.1.x, 4.0.x.

Added
  • configuration page of plugin
  • coediting docx, xlsx, pptx
  • customization document editor view
  • add goBack url for document editor
  • change favicon in editor by document type
  • detecting mobile browser
onlyoffice_redmine.zip (48.3 KB) onlyoffice_redmine.zip onlyoffice-redmine-1.0.0 Ascensio System SIA, 2021-11-03 09:55