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

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

Show settings page of the 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

Show Documents page

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.

Option	Permissions
View	View documents
Edit	View documents, Edit documents
Create	View documents, Edit documents
Convert: Save	View documents, Edit documents
Convert: Download	View documents

Attachment

Show Attachment page

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

Show Files page

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.

Option	Permissions
View	View files
Edit	View files, Manage files
Convert: Save	View files, Manage files
Convert: Download	View files

Issues

Show Issue page

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.

Option	Permissions
View	View issues
Edit	View issues, Edit own issues
Convert: Save	View issues, Edit own issues
Convert: Download	View issues

News

Show News page

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.

Option	Permissions
View	View news
Edit	View news, Manage news
Convert: Save	View news, Manage news
Convert: Download	View news

Wiki

Show Wiki page

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.

Option	Permissions
View	View wiki
Edit	View wiki, Edit wiki pages
Convert: Save	View wiki, Edit wiki pages
Convert: Download	View wiki

Forums

Show Forums page

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.

Option	Permissions
View	View messages
Edit	View messages, Edit messages
Convert: Save	View messages, Edit messages
Convert: Download	View messages

View Or Edit In ONLYOFFICE

Show editor page

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

Show create page

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

Show convert page

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.

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.