Redmine

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](#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.

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.