custom mattermost desktop application
Go to file
Devin Binnie 0cab09b7f5
[MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900)
* Add constants for app info, add to API

* Migrate history button

* Converted calls API over to context bridge, removed some unnecessary logging

* Convert to TS, add types for web app to consume

* Fix tests, prune

* Fix lint

* More changes to support the legacy API

* Force legacy code off, add support for unreads/mentions/expired through the API

* Fix issues with cross-tab login, removed need for log in/log out signalling

* Fixed test, typos

* Change package name for types

* Add some other stuff to the types

* PR feedback

* More feedback

* Use npm package

* Change types and API to provide off listeners

* Version number

* Lock

* Fix typo

* Add sessionID for calls
2023-12-13 09:39:46 -05:00
.config/notice-file Create configuration folder for notice.txt generation (#2149) 2022-06-14 10:15:40 +03:00
.github E2E: CI Improvements (#2918) 2023-12-13 14:24:16 +05:30
.vscode Exit process with code 1 if afterPack throws error (#2541) 2023-02-06 16:36:35 +02:00
api-types [MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900) 2023-12-13 09:39:46 -05:00
e2e E2E: CI Improvements (#2918) 2023-12-13 14:24:16 +05:30
fastlane Add skip_waiting_for_build_processing to CI build (#2027) 2022-03-29 11:35:55 -04:00
i18n Translated using Weblate (Polish) 2023-12-11 08:19:29 -05:00
resources/windows [MM-14093] Rename 'team' to 'server' and 'tab' to 'view' in most cases, some additional cleanup (#2711) 2023-05-08 09:17:01 -04:00
scripts [MM-54701] Fix development deep linking for login for Windows/Linux (#2867) 2023-10-10 10:07:10 -04:00
src [MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900) 2023-12-13 09:39:46 -05:00
.editorconfig Add recommended VSCode extensions (#2244) 2022-08-29 17:15:25 -04:00
.eslintignore Fix tests 2017-03-06 21:31:17 +09:00
.eslintrc-webapp.json [MM-43039] Upgrade and clean up dependencies (#2038) 2022-04-06 19:08:27 -04:00
.eslintrc.json [MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900) 2023-12-13 09:39:46 -05:00
.gitignore [MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900) 2023-12-13 09:39:46 -05:00
.gitlab-ci.yml Create makefile and pipeline to generate signed debian packages. (#2068) 2022-04-21 09:41:50 -04:00
babel.config.js Migrate app to TypeScript (#1637) 2021-06-28 09:51:23 -04:00
CHANGELOG.md Update CHANGELOG.md (#1089) 2019-10-24 00:12:02 +02:00
CONTRIBUTING.md MM-41988 Updated links to legacy domain about.mm.com (#2003) 2022-03-10 16:40:06 -05:00
electron-builder.json [GH 2874] Fix category for deb and clairfy directory information in README for linux (#2884) 2023-10-17 10:18:30 -04:00
entitlements.mac.plist Use build/ as CircleCI workspace (#1810) 2021-10-14 17:19:44 -04:00
entitlements.mas.inherit.plist [MM-42538] Submit nightly builds to TestFlight for macOS (#2023) 2022-03-28 11:06:00 -04:00
entitlements.mas.plist [MM-52581] Add USB entitlement for MAS build (#2710) 2023-05-05 16:44:20 -04:00
LICENSE.txt Change app author to Mattermost 2017-07-10 22:19:37 +09:00
Makefile Create makefile and pipeline to generate signed debian packages. (#2068) 2022-04-21 09:41:50 -04:00
NOTICE.txt Update NOTICE.txt (#2912) 2023-11-14 12:16:59 -05:00
package-lock.json [MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900) 2023-12-13 09:39:46 -05:00
package.json [MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900) 2023-12-13 09:39:46 -05:00
README.md [MM-14093] Rename 'team' to 'server' and 'tab' to 'view' in most cases, some additional cleanup (#2711) 2023-05-08 09:17:01 -04:00
SECURITY.md MM-41988 Updated links to legacy domain about.mm.com (#2003) 2022-03-10 16:40:06 -05:00
TESTING.md [MM-14093] Rename 'team' to 'server' and 'tab' to 'view' in most cases, some additional cleanup (#2711) 2023-05-08 09:17:01 -04:00
tsconfig.json [MM-22239] Downloads dropdown (#2227) 2022-10-07 11:40:27 +03:00
webpack.config.base.js Have all nightly branches include React Developer Tools (#2780) 2023-07-07 10:33:00 -04:00
webpack.config.main.js [MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up (#2900) 2023-12-13 09:39:46 -05:00
webpack.config.performance.test.js PoC performance tests in CI (#2474) 2023-01-30 17:16:10 +02:00
webpack.config.renderer.js Change default devServer port to 9065 (#2657) 2023-04-03 09:06:17 -04:00
webpack.config.test.js [MM-43039] Upgrade and clean up dependencies (#2038) 2022-04-06 19:08:27 -04:00

Mattermost Desktop

Mattermost is an open source platform for secure collaboration across the entire software development lifecycle. This repo is for the native desktop application that's built on Electron; it runs on Windows, Mac, and Linux.

Originally created as "electron-mattermost" by Yuya Ochiai.

mm-desktop-screenshot

Circle CI

Features

Desktop integration

  • Server dropdown for access to multiple servers
  • Dedicated tabs for Channels, Boards and Playbooks
  • Desktop Notifications
  • Badges for unread channels and mentions
  • Deep Linking to open Mattermost links directly in the app
  • Runs in background to reduce number of open windows

Usage

Installation

Detailed guides are available at docs.mattermost.com.

  1. Download a file from the downloads page or from the releases page.
  2. Run the installer or unzip the archive.
  3. Launch Mattermost from your Applications folder, menu, or the unarchived folder.
  4. On the first launch, please enter a name and URL for your Mattermost server. For example, https://mattermost.example.com.

Configuration

You can show the dialog from menu bar.

Configuration will be saved into Electron's userData directory:

  • %APPDATA%\Mattermost on Windows
  • ~/Library/Application Support/Mattermost on OS X
  • ~/.config/Mattermost on Linux

A custom data directory location can be specified with:

  • Mattermost.exe --args --data-dir C:\my-mattermost-data on Windows
  • open /Applications/Mattermost.app/ --args --data-dir ~/my-mattermost-data/ on macOS
  • ./mattermost-desktop --args --data-dir ~/my-mattermost-data/ on Linux

Custom App Deployments

Our docs provide a guide on how to customize and distribute your own Mattermost Desktop App, including how to distribute the official Windows Desktop App silently to end users, pre-configured with the server URL and other app settings.

Development and Making Contributions

Our developer guide has detailed information on how to set up your development environment, develop, and test changes to the Desktop App.