Redmine ONLYOFFICE integration plugin

Redmine ONLYOFFICE integration plugin

This plugin enables users to edit office documents within Redmine using ONLYOFFICE Docs.

The plugin is available in the official Redmine Plugins Directory.

Features

Currently, the following document formats can be edited: DOCX, XLSX, PPTX, DOCXF, OFORM.
The following formats are available for viewing only: DOC, DOCM, DOT, DOTX, DOTM, ODT, FODT, OTT, RTF, TXT, HTML, HTM, MHT, XML, PDF, DJVU, FB2, EPUB, XPS, XLS, XLSM, XLT, XLTX, XLTM, ODS, FODS, OTS, CSV, PPS, PPSX, PPSM, PPT, PPTM, POT, POTX, POTM, ODP, FODP, OTP.
The plugin will create a new Edit in ONLYOFFICE menu option within the document library for office documents. This allows multiple users to collaborate in real time and to save back those changes to Redmine.

Installing ONLYOFFICE Docs

You need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Redmine and any end clients. If that is not the case, use the official ONLYOFFICE Docs documentation page. ONLYOFFICE Docs must also be able to POST to Redmine directly.

The easiest way to start an instance of ONLYOFFICE Docs is to use Docker.

Installing Redmine ONLYOFFICE integration plugin

To start using ONLYOFFICE Docs with Redmine, the following steps must be performed:

If you’re new to Redmine, install it following these instructions.
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
```
Go to the Redmine ONLYOFFICE integration plugin folder and get a submodule:
```
cd onlyoffice-redmine
git submodule update --init --recursive
```
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.
Go to the Redmine directory:
```
cd redmine
```
Install dependencies:
```
bundle install
```

Initialize/Update database:

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

Configuring Redmine ONLYOFFICE integration plugin

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

Document Editing Service address: To connect ONLYOFFICE Docs, enter the following address:
```
https://<documentserver>:<port>/
```
where documentserver is the name of the server and port is the port number with ONLYOFFICE Docs installed.
Secret key: Starting from version 7.2, JWT 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 own secret key on the Redmine configuration page. In the ONLYOFFICE Docs config file, specify the same secret key and enable the validation.

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

How it works

The ONLYOFFICE integration follows the API documented here.

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 settings (permissions) of the user role.

Issues module

Files added when creating a task or from comments to a task are available for viewing and editing.

File editing is available for user roles with the Edit issues permission.

Opening files for viewing is available for user roles with the View issues permission.
Files module

Files are available only for viewing for users who have the View files or Manage files permissions.
Documents module

The uploaded files in this module are available for viewing and editing.

Document editing is available for user roles with the Edit documents permission.

Opening documents for viewing is available for user roles with the View documents permission.
Wiki module

The uploaded files in this module are available for viewing and editing.

File editing is available for user roles with the Edit Wiki pages permission.

Opening files for viewing is available for user roles with the View Wiki permission.
News module

The uploaded files in this module are available for viewing and editing.

File editing is available for user roles with the Manage news permission.

Opening files for viewing is available for user roles with the View news permission.
Saving changes

All the changes made in the document are saved in the original file.

Download the Redmine ONLYOFFICE integration plugin here.