aaron/mattermost-desktop
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity
custom mattermost desktop application
2081 commits 1 branch 94 tags 43 MiB
TypeScript 54.2%
JavaScript 38.1%
SCSS 4.2%
CSS 2.3%
Shell 0.9%
Other 0.1%
Go to file
Guillermo Vayá 4e75007362
[Mm 37198] enable global sandboxing to increase security (#1667) 
* prevent creating new windows from popup windows

* enable sandbox

* fix windows detection logic

* disable on testing environment

Co-authored-by: = <=>
2021-07-23 16:07:48 +02:00
.circleci [MM-36459] Drag and drop for dropdown (#1651) 2021-07-14 16:29:35 -04:00
.github add beta template (#1561) 2021-04-22 17:57:25 +02:00
.vscode Fix Mocha debug config 2019-03-12 23:45:52 +09:00
build [MM-31987] Allow camera use for jitsi (#1443) 2021-01-18 22:43:13 +01:00
docs [MM-23067] Browser View (#1514) 2021-03-18 15:51:53 +01:00
resources/windows Update icons (#1545) 2021-04-16 19:29:40 +02:00
scripts Migrate app to TypeScript (#1637) 2021-06-28 09:51:23 -04:00
src [Mm 37198] enable global sandboxing to increase security (#1667) 2021-07-23 16:07:48 +02:00
test Migrate app to TypeScript (#1637) 2021-06-28 09:51:23 -04:00
.editorconfig [MM-23067] Browser View (#1514) 2021-03-18 15:51:53 +01:00
.eslintignore Fix tests 2017-03-06 21:31:17 +09:00
.eslintrc-webapp.json [MM-23067] Browser View (#1514) 2021-03-18 15:51:53 +01:00
.eslintrc.json Migrate app to TypeScript (#1637) 2021-06-28 09:51:23 -04:00
.gitignore [MM-23067] Browser View (#1514) 2021-03-18 15:51:53 +01: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 Update CONTRIBUTING.md 2018-05-25 00:05:47 +09:00
electron-builder.json add rpm build option to electron builder (#1611) 2021-05-26 10:22:51 +02:00
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md (#930) 2019-04-10 20:42:29 -04:00
LICENSE.txt Change app author to Mattermost 2017-07-10 22:19:37 +09:00
NOTICE.txt Update NOTICE.txt (#1573) 2021-04-29 17:37:28 +02:00
package-lock.json [MM-36753] Revert to Electron v12.0.1 (#1665) 2021-07-21 16:47:29 -04:00
package.json [MM-36753] Revert to Electron v12.0.1 (#1665) 2021-07-21 16:47:29 -04:00
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md for eslint 2016-11-07 22:00:21 +09:00
README.md Update README.md (#1641) 2021-06-29 17:30:20 +02:00
SECURITY.md MM-20627: Create SECURITY.md (#1145) 2020-01-09 11:41:25 +02:00
TESTING.md Update TESTING.md 2017-11-17 11:31:35 -05:00
tsconfig.json Migrate app to TypeScript (#1637) 2021-06-28 09:51:23 -04:00
webpack.config.base.js Migrate app to TypeScript (#1637) 2021-06-28 09:51:23 -04:00
webpack.config.main.js [MM-36421] Replace server tabs with dropdown menu (#1647) 2021-07-07 18:49:48 -04:00
webpack.config.renderer.js Bootstrap v4 dark mode for modals and settings window (#1650) 2021-07-09 17:19:49 -04:00
webpack.config.test.js Migrate app to TypeScript (#1637) 2021-06-28 09:51:23 -04:00

README.md

Mattermost Desktop

Native desktop application for Mattermost running on Windows, Mac, and Linux.

Originally created as "electron-mattermost" by Yuya Ochiai. Developed using Electron.

screenshot_20

Circle CI

Features

Desktop integration

  • Tabs for multiple teams across multiple servers
  • Desktop Notifications
    • Windows 10: Toast
    • Windows 7-8.1: Popup like Toast
    • OS X: Notification Center
    • Linux: libnotify
  • Badges for unread channels and mentions
  • Installs as a native application

Pre-packaged

You don't have to install any other software. Packages are available on the releases page.

Usage

Installation

Detailed guides are available at docs.mattermost.com.

  1. Download a file from the downloads page.
  2. Launch Mattermost in the unarchived folder.
  3. On the first launch, please input name and URL for your Mattermost server. For example, myserver : https://mattermost.example.com.

Quit

Ctrl or Command + Q to quit.

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

When you upgrade from electron-mattermost, please copy config.json from electron-mattermost. Otherwise, you have to configure again.

Proxy

Normally, the application will follow your system settings to use a proxy, or you can set up a proxy by the following command line options.

  • --proxy-server=<SERVER>:<PORT>
  • --proxy-pac-url=<URL>

On Windows, please make sure to add -- before options. For example, Mattermost.exe -- --proxy-server=....

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.

Contributing

Please see CONTRIBUTING.md.

Development

Please see docs/development.md.