This app enables users to edit office documents from Mattermost using ONLYOFFICE Docs.
The app allows to:
- Open office files sent in personal and group Mattermost chats for viewing and real-time co-editing.
- Share files with basic permission types - viewing/editing.
- Create files in chats.
For viewing:
- WORD: DOC, DOCM, DOCX, DOT, DOTM, DOTX, EPUB, FB2, FODT, HML, HTM, HTML, HWP, HWPX, MD, MHT, MHTML, ODT, OTT, PAGES, RTF, STW, SXW, TXT, WPS, WPT, XML
- CELL: CSV, ET, ETT, FODS, NUMBERS, ODS, OTS, SXC, TSV, XLS, XLSB, XLSM, XLSX, XLT, XLTM, XLTX
- SLIDE: DPS, DPT, FODP, KEY, ODG, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, PPTX, SXI
- PDF: DJVU, OXPS, PDF, XPS
- DIAGRAM: VSDM, VSDX, VSSM, VSSX, VSTM, VSTX
For editing:
- WORD: DOCM, DOCX, DOTM, DOTX
- CELL: XLSB, XLSM, XLSX, XLTM, XLTX
- SLIDE: POTM, POTX, PPSM, PPSX, PPTM, PPTX
- PDF: PDF
You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Mattermost and any end clients. ONLYOFFICE Document Server must also be able to POST to Mattermost directly.
ONLYOFFICE Document Server and Mattermost can be installed either on different computers or on the same machine. In case you choose the latter option, you need to set up a custom port for Document Server.
You can install free Community version of ONLYOFFICE Docs or scalable Enterprise Edition.
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.
You can also opt for ONLYOFFICE Docs Cloud which doesn't require downloading and installation.
To get ONLYOFFICE Docs Cloud, get started here.
- Install Node.js. Check instructions
- Install Go. Check instructions
- Install make:
sudo apt install make
- Clone the plugin branch:
git clone https://github.com/ONLYOFFICE/onlyoffice-mattermost.git
- Go to the project root and fetch git submodules:
cd onlyoffice-mattermost/ git submodule update --init --recursive - Start the build:
make
As a Mattermost administrator, configure the app via the System Console. App Marketplace -> find ONLYOFFICE app -> click the Configure button.
-
ONLYOFFICE Docs address: The URL of the installed ONLYOFFICE Docs (Document Server).
-
Document Server JWT Secret: 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. If needed, specify your own secret key in the Mattermost plugin configuration. In the ONLYOFFICE Docs config file, specify the same secret key and enable the validation.
-
JWT Header: If 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).
-
JWT Prefix: Used to specify the ONLYOFFICE Docs prefix.
You can also connect to the public test server of ONLYOFFICE Docs for one month by checking the corresponding box.
Context menu
When files are sent in the chat message, the following actions are available in the file context menu by clicking the ⋮ symbol:
- Open file in ONLYOFFICE and Change access rights — for the author of the message.
- Open file in ONLYOFFICE — for the recipient of the message.
Creating a new file
Users can create new files directly in the chat: click on the paperclip icon in the message input field and click ONLYOFFICE. Next, specify the file name, select the file format (Document, Spreadsheet, Presentation), and click the Create button. A message with the created file will be sent to the chat.
Opening the editors
Clicking on the file name opens a preview of the file with the Open button.
When clicking on the Open file in ONLYOFFICE button, the corresponding ONLYOFFICE editor opens in the same window.
You can also open the file via the file context menu in the message.
Setting file access rights
By default, the sender of a message has full editing access to the file, while all recipients are granted read-only access. Only the sender can modify user access rights through the context menu by selecting the Change access rights option.
In personal chats: Access rights can be adjusted using a drop-down menu. When the access level is changed, the ONLYOFFICE bot will send a notification to the chat.
In group chats: A Default access rights option is available for quickly setting permissions for all participants. To grant specific access rights to an individual, simply type their name in the search bar and click Add.
The user will then appear in a list where you can assign their desired access level. To remove a user, click the cross icon next to their name. Their access will revert to the permissions set under Default access rights.
Whenever access levels are updated, the ONLYOFFICE bot will notify the chat. For individual changes, the bot will send a personal notification to the affected participant.
Tracking changes
ONLYOFFICE bot sends notifications about changes in the document specifying the name of the user who made those changes.
All change notifications can be found within the message's discussion thread. Simply click the arrow on the right edge of the message to open a panel on the right, where the full history of the message's discussion is displayed.
Changes cannot be saved to storage when using S3 for storage in Mattermost (affects Mattermost 11.7.2 only).
ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.
- Community Edition 🆓 (
onlyoffice-documentserverpackage) - Enterprise Edition 🏢 (
onlyoffice-documentserver-eepackage)
The table below will help you to make the right choice.
| Pricing and licensing | Community Edition | Enterprise Edition |
|---|---|---|
| Get it now | Start Free Trial | |
| Cost | FREE | Go to the pricing page |
| Number of users | up to 20 recommended | As in chosen pricing plan |
| License | GNU AGPL v.3 | Proprietary |
| Support | Community Edition | Enterprise Edition |
| Documentation | Help Center | Help Center |
| Standard support | GitHub or Community | 1 or 3 years support included |
| Premium support | Contact us | Contact us |
| Services | Community Edition | Enterprise Edition |
| Conversion Service | + | + |
| Live Viewer | + | + |
| Document Builder Service | - | - |
| Automation API | - | - |
| Interface | Community Edition | Enterprise Edition |
| Tabbed interface | + | + |
| Dark theme | + | + |
| 125%, 150%, 175%, 200% scaling | + | + |
| White Label | - | - |
| Integrated test example (node.js) | + | + |
| Admin Panel | - | + |
| Mobile web editors | - | +* |
| Plugins & Macros | Community Edition | Enterprise Edition |
| Plugins | + | + |
| Macros | + | + |
| Collaborative capabilities | Community Edition | Enterprise Edition |
| Two co-editing modes | + | + |
| Comments | + | + |
| Built-in chat | + | + |
| Review and tracking changes | + | + |
| Display modes of tracking changes | + | + |
| Version history | + | + |
| Document Editor features | Community Edition | Enterprise Edition |
| Font and paragraph formatting | + | + |
| Object insertion | + | + |
| Adding Content control | + | + |
| Editing Content control | + | + |
| Layout tools | + | + |
| Table of contents | + | + |
| Navigation panel | + | + |
| Mail Merge | + | + |
| Comparing documents | + | + |
| Multipage View | + | + |
| Spreadsheet Editor features | Community Edition | Enterprise Edition |
| Font and paragraph formatting | + | + |
| Object insertion | + | + |
| Functions, formulas, equations | + | + |
| Table templates | + | + |
| Pivot tables | + | + |
| Data validation | + | + |
| Conditional formatting | + | + |
| Sparklines | + | + |
| Sheet Views | + | + |
| Solver | + | + |
| Presentation Editor features | Community Edition | Enterprise Edition |
| Font and paragraph formatting | + | + |
| Object insertion | + | + |
| Transitions | + | + |
| Animations | + | + |
| Presenter mode | + | + |
| Notes | + | + |
| Slide Master | + | + |
| Form creator features | Community Edition | Enterprise Edition |
| Adding form fields | + | + |
| Form preview | + | + |
| Saving as PDF | + | + |
| Role-matching colors for fields | + | + |
| PDF Editor features | Community Edition | Enterprise Edition |
| Text editing and co-editing | + | + |
| Work with pages (adding, deleting, rotating) | + | + |
| Inserting objects (shapes, images, hyperlinks, etc.) | + | + |
| Text annotations (highlight, underline, cross out, stamps) | + | + |
| Redact | + | + |
| Comments | + | + |
| Freehand drawings | + | + |
| Form filling | + | + |
| Get it now | Start Free Trial |
* If supported by DMS.
- 🐞 Found a bug? Please report it by creating an issue.
- ❓ Have a question? Ask our community and developers on the ONLYOFFICE Forum.
- 👨💻 Need help for developers? Check our API documentation.