Requirements

• ONLYOFFICE Docs (Document Server) 6.4.0 or later

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

  Please refer to the official documentation page to learn more about installing ONLYOFFICE Docs.

  You can also use ONLYOFFICE Docs Cloud (SaaS version).

• Mattermost v. 5.37.2 or later
• ONLYOFFICE Connector v1.1.1 for Mattermost

Installing the ONLYOFFICE connector for Mattermost

Configuring the ONLYOFFICE Connector for Mattermost

Go to System Console -> find the ONLYOFFICE plugin via search -> Configure. Enable the plugin in the corresponding field and specify the following parameters:

1. Document Editing Service address - enter the URL address where ONLYOFFICE Docs is installed (e.g. https://documentserver).
   ImportantThe address of ONLYOFFICE Docs must be accessible from Mattermost, as well as the address of Mattermost must be accessible from ONLYOFFICE Docs.
2. Secret key - the document server JWT 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 Mattermost 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 Mattermost integration section of this article.
3. JWT Header - specify the JWT header.
   ImportantIf JWT protection is enabled, it is necessary to specify a custom header name since the Mattermost security policy blocks external 'Authorization' Headers. This header should be specified in the ONLYOFFICE Docs signature settings as well (further information can be found here).
4. JWT Prefix - specify the JWT prefix.

Enabling JWT for the ONLYOFFICE and Mattermost 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.

Viewing and editing files

Viewing changes history

All changes to the file will be sent as notifications containing the username.

The notifications are available in a dedicated thread. To open the thread, click the arrow to the right of the file.