This app enables users to edit office documents from Redmine using ONLYOFFICE Docs packaged as Document Server - Community or Enterprise Edition.

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, DOCXF, OFORM.
• 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.

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 (recommended) or follow these instructions for Debian, Ubuntu, or derivatives.

To install Enterprise Edition, follow the instructions here.

Community Edition vs Enterprise Edition comparison can be found here.

1. If you're new to Redmine, install it following these instructions.

2. 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 the Redmine ONLYOFFICE integration plugin folder and get a submodule:

   cd onlyoffice-redmine
   git submodule update --init --recursive
   

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

4. Go to the Redmine directory:

   cd redmine
   

5. Install dependencies:

   bundle install
   

6. Initialize/Update database:

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

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

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.

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 are available only for viewing for users who have the View files or Manage files permissions.

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.

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.

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.

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

ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.

ONLYOFFICE Docs packaged as Document Server:

• Community Edition (onlyoffice-documentserver package)
• Enterprise Edition (onlyoffice-documentserver-ee package)

The table below will help you make the right choice.

* If supported by DMS.