Redmine ONLYOFFICE Integration Plugin

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

* To be able to open the format for editing, check it in the formats settings. Due to some format restrictions, data loss may occur.

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. You can read about their differences below.

We recommend using Docker to install the free Community version. Alternatively, you can follow these instructions for Debian, Ubuntu, or derivatives.

To install Enterprise Edition, follow these instructions.

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.

Additionally, you may need zstd to unzip the plugin.

If you are new to Redmine, install it by following these instructions.

Once you have installed Redmine, download the plugin.

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.

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, 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.

How It Works

The plugin uses the ONLYOFFICE Docs API and is integrated into various Redmine pages, including Documents, Attachments, Files, Issue, News, Wiki, and Forums. Additionally, the plugin adds general pages such as "Create In ONLYOFFICE" and "Convert In ONLYOFFICE".

Documents

On the Documents page, users can open the attachment to view, edit, create, or convert it. The options displayed in the interface may vary depending on the user permissions.

Attachment

On the Attachment page, users can open the attachment to view, edit, or convert it. The options displayed in the interface may vary depending on the user's permissions for the module where the attachment is located.

Files

On the Files page, users can open the attachment to view, edit, or convert it. The options displayed in the interface may vary depending on the user's permissions.

Issues

On the Issue page, users can open the attachment to view, edit, or convert it. The options displayed in the interface may vary depending on the user's permissions.

News

On the News page, users can open the attachment to view, edit, or convert it. The options displayed in the interface may vary depending on the user's permissions.

Wiki

On the Wiki page, users can open the attachment to view, edit, or convert it. The options displayed in the interface may vary depending on the user's permissions.

Forums

On the Forums page, users can open the attachment to view, edit, or convert it. The options displayed in the interface may vary depending on the user's permissions.

View Or Edit In ONLYOFFICE

On the "View Or Edit In ONLYOFFICE" page, users can view or edit the attachment. The visibility of this page depends on the user's permissions for the module where the attachment is located.

Create In ONLYOFFICE

On the "Create In ONLYOFFICE" page, users can create the attachment using templates that consider the user's language preference. Take a look at supported formats. The visibility of this page depends on the user's permissions for the module.

Convert In ONLYOFFICE

On the "Convert In ONLYOFFICE" page, the user can convert the attachment. The visibility of this page depends on the user's permissions for the module where the attachment is located.

ONLYOFFICE Docs Editions

ONLYOFFICE offers different versions of ONLYOFFICE Docs editors that can be deployed on your own servers:

• Community Edition: onlyoffice-documentserver package.
• Enterprise Edition: onlyoffice-documentserver-ee package.

The table below will help you make the right choice.

* If supported by DMS.