flagEnglish
arrow-down
en-USEnglish
de-DEDeutsch
fr-FRFrançais
Redmine
HomeConnectorsRedmine

Redmine

  • connectors
  • integration
  • ONLYOFFICE Docs

    • Watch video

    How to integrate ONLYOFFICE with Redmine
    Learn how to integrate ONLYOFFICE online editors with Redmine using the connector, which allows to easily edit and collaborate on text documents, spreadsheets, and presentations.

    About the ONLYOFFICE and Redmine integration

    ONLYOFFICE offers an official connector to integrate ONLYOFFICE Docs with Redmine to collaborate on office documents attached to the following Redmine modules: Issues, Files, Documents, Wiki, and News. You can download the ONLYOFFICE connector from the Redmine Marketplace or the ONLYOFFICE GitHub page. The application is distributed under the Apache license.

    To learn more about how the ONLYOFFICE connector for Redmine works, please visit our API documentation.

    Main features
    • Viewing and editing text documents, spreadsheets, and presentations from the Redmine modules depending on the user access rights.
    • Creating and filling out online forms.
    • Co-editing documents in real-time: two co-editing modes (Fast and Strict), Track Changes, comments, and a built-in chat.
    • JWT support to secure your traffic so that no one, besides the users with proper rights, can have access to your documents.
    Supported formats
    • For creating and editing: DOCX, DOCXF, PPTX, XLSX
    • For filling forms: 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.
    What's new in version 2.0.0

    Added

    • Documents conversion.
    • Connection to a demo document server.
    • Advanced server settings for specifying internal addresses.
    • Settings validation.
    • Ignoring self-signed certificates.

    Fixed

    • Issues with permissions.

    The full change log is available here.

    Connecting ONLYOFFICE Docs to Redmine

    Requirements
    • ONLYOFFICE Document Server v7.1 (server or cloud version) or later

      You need an instance of ONLYOFFICE Docs that is resolvable and connectable both from Redmine and any end clients. It must be able to POST to Redmine directly.

      Please refer to the official documentation page to learn more about installing ONLYOFFICE Docs.
    • Redmine v4.0.0 - v5.0.x. If you're new to Redmine, install it following these instructions.
    • ONLYOFFICE Connector v2.0.0 for Redmine
    Installing the ONLYOFFICE connector for Redmine
    1. Download the ONLYOFFICE integration plugin for Redmine. There are several ways to do that:
      1. Download the latest archived version from the Redmine Marketplace.
      2. Download the latest archived version from the ONLYOFFICE GitHub page: 
        wget https://github.com/ONLYOFFICE/onlyoffice-redmine/archive/refs/tags/vX.X.X.tar.gz

        Where vX.X.X is the necessary connector version.

        Unzip the archive:

        tar -xvzf vX.X.X.tar.gz
      3. Clone the master branch: 
        git clone https://github.com/ONLYOFFICE/onlyoffice-redmine
      The plugin sub-directory must be named as onlyoffice_redmine. Rename the cloned onlyoffice-redmine or unzipped onlyoffice_redmine-X.X.X folder to onlyoffice_redmine. 
      >mv onlyoffice-redmine onlyoffice_redmine
mv onlyoffice-redmine-X.X.X onlyoffice_redmine

      Before installing the plugin, make sure that the Redmine instance is stopped.

    2. Put the onlyoffice_redmine plugin directory into the plugins directory, e.g: 
      cp -r /root/onlyoffice_redmine/. /redmine/plugins/onlyoffice_redmine
      The path to the plugins directory may differ depending on your Redmine installation options. You can use the find / -type d -name plugins command to find the path.
    3. Go to the Redmine’s root directory: 
      cd redmine
    4. Install dependencies: 
      bundle install
    5. Initialize/Update the database: 
      RAILS_ENV=production bundle exec rake db:migrate
      RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=onlyoffice_redmine
    6. Restart the Redmine instance.
    Configuring the ONLYOFFICE connector for Redmine

    Go to the Administration panel -> Plugins, find the ONLYOFFICE integration plugin for Redmine and click Configure. Specify the following parameters:

    • Document Editing Service address - enter the URL address and port where ONLYOFFICE Docs is installed (e.g. https://documentserver:8080). This field is obligatory.
      The address of ONLYOFFICE Docs must be accessible from Redmine, as well as the address of Redmine must be accessible from ONLYOFFICE Docs.
    • The Advanced server settings section can be used if your network configuration does not allow for requests between the installed Redmine and ONLYOFFICE Docs using the public addresses. In this case, specify addresses for internal requests in the corresponding fields:
      • ONLYOFFICE Docs address for internal requests from the server - specify the address that is used to access Document Editing Service from Redmine.
      • Server address for internal requests from ONLYOFFICE Docs - specify the address that is used to access Redmine from Document Editing Service.
    • Secret key - specify the secret used to sign the data.
      Starting from ONLYOFFICE Docs v7.2, JWT is enabled by default and the secret key is generated automatically. You need to enable it on the Redmine side as well: find your secret key in the ONLYOFFICE Docs configuration file, then specify the same secret key in the connector settings. For more details, see the Enabling JWT for the ONLYOFFICE and Redmine integration section of this article.
    • Disable certificate verification (insecure) - check this box to disable the certificate verification and allow Redmine to establish connection with ONLYOFFICE Docs if you are using a self-signed certificate for your ONLYOFFICE Docs (otherwise, Redmine will not validate a self-signed certificate and will not allow for connection to/from ONLYOFFICE Docs). This is an insecure solution, and we strongly recommend that you replace the certificate with the one issued by some CA.
    • Check the following customization settings if necessary:
      • Display the Chat menu button.
      • Display the header in a more compact way.
      • Display the Feedback & Support menu button.
      • Display the Help menu button.
      • Display the monochrome toolbar header.

    Click the Apply button at the bottom to save changes.

    ONLYOFFICE_configureONLYOFFICE_configure
    Enabling JWT for the ONLYOFFICE and Redmine integration

    To protect documents from unauthorized access, ONLYOFFICE editors use the JSON Web Token (JWT). The token is added in the configuration when the Document Editor is initialized and during the exchange of commands between inner ONLYOFFICE Docs services. The secret key is used to sign the JSON web token and validate the token upon the request to ONLYOFFICE Docs.

    Starting from ONLYOFFICE Docs v7.2, JWT is enabled by default and the secret key is generated automatically. You need to find your secret key in the ONLYOFFICE Docs configuration file, then specify the same secret key in the connector settings.

    Step 1: Find your secret key in the ONLYOFFICE Docs configuration file

    1. Open the local.json file with any available text editor.
      • For Linux - /etc/onlyoffice/documentserver/local.json
      • For Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
      • For Docker – enter the ONLYOFFICE Docs container using the docker exec -it <containerID> bash command and open /etc/onlyoffice/documentserver/local.json

        Alternatively, you can use the following command to find the default secret key without opening local.json:

        sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

      The local.json file should look like this:

      {"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}}
    2. The true value is specified in three sections. It means that token validation is enabled.
      • services.CoAuthoring.token.enable.browser
      • services.CoAuthoring.token.enable.request.inbox
      • services.CoAuthoring.token.enable.request.outbox
    3. The automatically generated secret key is specified in three sections. You can replace the default secret value with your own secret key. The secret key must be the same in three sections.
      • services.CoAuthoring.secret.inbox.string
      • services.CoAuthoring.secret.outbox.string
      • services.CoAuthoring.secret.session.string
    4. If you make changes, save them and restart the services for the config changes to take effect. 
      supervisorctl restart all

    Step 2: Specify the same secret key in the connector settings

    In the connector settings, specify the same secret in the Secret key field and save the settings.

    Connecting to the demo ONLYOFFICE Docs

    Starting from ONLYOFFICE connector version 2.0.0, you can try the ONLYOFFICE online editors within Redmine without installing ONLYOFFICE Docs.

    To turn the connection on, click the Connect to demo ONLYOFFICE Document Server checkbox and click the Save button.

    ImportantThis is a public test server that will be available during a 30-day period. Don’t share your sensitive data there.

    Start using ONLYOFFICE Docs within Redmine

    All file changes are saved in the original file.
    Changing permissions

    Please note that available file actions (viewing or editing) for each particular module depend on the permissions of the user role.

    Go to Administration -> Roles and permissions, choose the necessary role in the list, check/uncheck the necessary permissions and click Save.

    You can refer to the official Redmine documentation for more details.

    Issues module

    To open the files attached to issues or to issue comments in the corresponding editor, click the ONLYOFFICE icon Edit in ONLYOFFICE / Open in ONLYOFFICE button to the right of the file name.

    The ability to edit documents is available for user roles with the Edit issues permission.

    The ability to open files for viewing is available for user roles with the View issues permission.

    Issues moduleIssues module
    Files module

    Files are available for viewing only and exclusively to the users with View files or Manage files permissions. To open a file in the corresponding editor, click the ONLYOFFICE icon Open in ONLYOFFICE button to the right of the file name.

    Files moduleFiles module
    Documents module

    To open files in the corresponding editor, click the ONLYOFFICE icon Edit in ONLYOFFICE / Open in ONLYOFFICE button to the right of the file name.

    The ability to edit documents is available for user roles with the Edit documents permission.

    The ability to open files for viewing is available for user roles with the View documents permission.

    Documents moduleDocuments module

    To create a form, click the Create in ONLYOFFICE link and choose the Form Template option.

    create a formcreate a form

    Fill in the required fields and click Create.

    To learn more about forms, please read the corresponding articles for creating and filling out forms.
    Wiki module

    To open files in the corresponding editor, click the ONLYOFFICE icon Edit in ONLYOFFICE / Open in ONLYOFFICE button to the right of the file name.

    The ability to edit documents is available for user roles with the Edit Wiki pages permission.

    The ability to open files for viewing is available for user roles with the View Wiki permission.

    Wiki moduleWiki module
    News module

    To open files in the corresponding editor, click the ONLYOFFICE icon Edit in ONLYOFFICE / Open in ONLYOFFICE button to the right of the file name.

    The ability to edit documents is available for user roles with the Edit news permission.

    The ability to open files for viewing is available for user roles with the View news permission.

    News moduleNews module
    Converting files

    The ability to convert files is available in the following Redmine modules: Issues, Documents, Wiki, and News.

    Converting filesConverting files

    Click the ONLYOFFICE icon Convert with ONLYOFFICE button to the right of the file name.

    Choose the necessary format from the list. Optionally, you can change the file name.

    Converting filesConverting files

    Click the Convert button to save the converted file within the corresponding Redmine section. Click the Download button to save the converted file on your computer locally.

    Host ONLYOFFICE Docs on your own server or use it in the cloud

    Article with the tag:
    Browse all tags