Redmine

This plugin enables users to edit office documents, spreadsheets, and presentations from Redmine using ONLYOFFICE Docs. Multiple users can collaborate on files in real time using two co-editing modes, Track Changes, comments, and built-in chat.
Redmine ONLYOFFICE integration plugin allows opening files uploaded to the Issues, Files, Documents, Wiki, or News modules for viewing and co-editing. For each module, the access rights to view/edit files depend on the permissions of the user role.

Features¶

The app allows to:

• Edit text documents, spreadsheets, and presentations.
• Co-edit documents in real-time: use two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat.

Supported formats:

• For editing: DOCX, XLSX, PPTX.
• For viewing: DOC, DOCX, DOCM, DOT, DOTX, DOTM, ODT, FODT, OTT, RTF, TXT, HTML, HTM, MHT, XML, PDF, DJVU, FB2, EPUB, XPS, XLS, XLSX, XLSM, XLT, XLTX, XLTM, ODS, FODS, OTS, CSV, PPS, PPSX, PPSM, PPT, PPTX, PPTM, POT, POTX, POTM, ODP, FODP, OTP.

Configuring¶

Configure the plugin via the Redmine interface. Go to Administration -> Plugins -> Onlyoffice Redmine plugin -> Configure and specify the following parameters:

Document Editing Service address:
The URL and port of the installed ONLYOFFICE Document Server.

Secret key:
Enables JWT to protect your documents from unauthorized access (further information can be found here https://api.onlyoffice.com/editors/signature/).

You can also configure the Editor customization settings:

- Display or hide Chat menu button

- Display the header more compact

- Display or hide Feedback & Support menu button

- Display or hide Help menu button

- Display monochrome toolbar header

Installing ONLYOFFICE Docs¶

You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Redmine and any end clients. ONLYOFFICE Document Server must also be able to POST to Redmine directly.

You can install free Community version of ONLYOFFICE Docs or scalable Enterprise Edition with pro features.

To install free Community version, use Docker https://github.com/onlyoffice/Docker-DocumentServer (recommended) or follow these instructions https://helpcenter.onlyoffice.com/installation/docs-community-install-ubuntu.aspx for Debian, Ubuntu, or derivatives.

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

Installing Redmine ONLYOFFICE integration plugin¶

1. Download Redmine ONLYOFFICE integration plugin. You can either clone the master branch or download the latest zipped version. Before installing, make sure that the Redmine instance is stopped.
git clone https://github.com/ONLYOFFICE/onlyoffice-redmine

2. Put onlyoffice_redmine plugin directory into plugins. The plugins sub-directory must be named as onlyoffice_redmine. If necessary, rename onlyoffice_redmine-x.y.z to onlyoffice_redmine.

3. Go to the Redmine directory:
cd redmine

4. Install dependencies:
bundle install

5. Initialize/Update database:
RAILS_ENV=production bundle exec rake db:migrate
RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=onlyoffice_redmine