Integrating ONLYOFFICE Docs with Redmine: A Complete Setup Guide

ONLYOFFICE Docs is a powerful, open-source office suite that provides collaborative online editors for text documents, spreadsheets, and presentations. It fully supports OOXML file formats and can be seamlessly integrated with several cloud platforms, including Nextcloud, Seafile, Alfresco, Redmine, ownCloud, and more.

Redmine, on the other hand, is a versatile open-source platform for project management and issue tracking. By connecting ONLYOFFICE Docs with Redmine, you enable in-place editing and collaborative features for docx, xlsx, and pptx files uploaded in modules like Issues, Files, Documents, Wiki, and News. Access permissions for editing or viewing documents are governed by the role-based permissions set in each Redmine module.

System Requirements

• ONLYOFFICE Docs (Document Server) version 6.4
• Redmine version 4.0 or newer
• ONLYOFFICE Connector plugin for Redmine

Step 1: Obtain the Connector

To begin, download the ONLYOFFICE Connector plugin for Redmine.

You can clone the official repository’s master branch:

$ git clone https://github.com/ONLYOFFICE/onlyoffice-redmine

Alternatively, download the archived release and extract it:

$ wget https://github.com/ONLYOFFICE/onlyoffice-redmine/archive/refs/tags/v1.0.0.tar.gz

$ tar -xvzf v1.0.0.tar.gz

Rename the extracted directory:

For the cloned version:

$ mv onlyoffice-redmine onlyoffice_redmine

For the archive version:

$ mv onlyoffice-redmine-1.0.0 onlyoffice_redmine

Step 2: Install the Plugin

Ensure your Redmine server is not running during the plugin installation.

Move the plugin folder into the appropriate Redmine plugins directory:

$ cp -r /root/onlyoffice_redmine/. /redmine/plugins/onlyoffice_redmine

If you’re unsure about the plugins path, locate it using:

$ find / -type d -name plugins

Navigate to the root of your Redmine installation:

$ cd redmine

Install the required dependencies:

$ bundle install

Update the database schema:

$ RAILS_ENV=production bundle exec rake db:migrate

$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=onlyoffice_redmine

Restart your Redmine instance to apply the changes.

Step 3: Set Up ONLYOFFICE Document Server in Redmine

Use the Redmine admin interface to configure the document server:

• Navigate to Administration → Plugins and find the ONLYOFFICE Redmine plugin.
• Click on Configure.
• Fill out the required fields:
  • Document Editing Service address: Provide the URL and port, e.g., https://documentserver:8080.
  • Secret key: Use the same JWT key configured in the ONLYOFFICE Document Server to restrict unauthorized access.
  • Editor customization options:
    • Show Chat menu button
    • Show Feedback & Support menu button
    • Use compact header display
    • Show Help menu button
    • Use monochrome toolbar header
• Click Apply to save your settings.

Conclusion

You have now successfully integrated ONLYOFFICE Docs with Redmine. This setup allows you to view and collaboratively edit Office documents directly within the Redmine environment, eliminating the need to switch between separate applications.