aaron/mattermost-desktop
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity
custom mattermost desktop application
1965 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
Nev Angelova 9eca54daf4
[MM-24154] - Fix copy/paste mismatch by upgrading electron context menu (#1313) 
Co-authored-by: Nevyana Angelova <nevyangelova@Nevyanas-MBP.fritz.box>
2020-06-05 16:51:57 +02:00
.circleci Fix typo in release message (#1307) 2020-06-02 08:59:46 +02:00
.github/ISSUE_TEMPLATE Update bug_report.md 2018-05-22 09:37:47 -04:00
.vscode Fix Mocha debug config 2019-03-12 23:45:52 +09:00
docs Update release-process.md (#1283) 2020-05-08 09:34:54 +02:00
resources [MM-20348] Fixed DMG background (#1114) 2019-11-29 09:56:10 -05:00
scripts [MM-22495] change position of option to its proper place 2020-05-15 01:42:27 +02:00
src [MM-24154] - Fix copy/paste mismatch by upgrading electron context menu (#1313) 2020-06-05 16:51:57 +02:00
test [MM-22648] basic auth external sites (#1295) 2020-05-28 10:53:57 +02:00
.editorconfig Force to use LF and add editorconfig 2016-02-26 00:07:04 +09:00
.eslintignore Fix tests 2017-03-06 21:31:17 +09:00
.eslintrc-webapp.json [MM-23332] fix eslint (#1238) 2020-03-17 21:34:38 +01:00
.eslintrc.json [MM-14740] Integrate GPO functionality (#961) 2019-04-18 13:19:04 -04:00
.gitignore [MM-19856] Add back button when navigating outside of MM server (#1179) 2020-03-19 21:51:26 +01:00
babel.config.js Upgrade babel, webpack and storybook stack 2018-12-04 23:35:14 +09: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 [MM-19856] Add back button when navigating outside of MM server (#1179) 2020-03-19 21:51:26 +01: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 file with electron version and new 'winreg' dependency 2019-05-11 23:35:46 +02:00
package-lock.json [MM-22648] basic auth external sites (#1295) 2020-05-28 10:53:57 +02:00
package.json [MM-22648] basic auth external sites (#1295) 2020-05-28 10:53:57 +02: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 (#960) 2019-04-18 12:37:20 -04: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
webpack.config.base.js Add eslint-plugin-eslint-comments 2019-03-12 23:31:45 +09:00
webpack.config.main.js [MM-22648] basic auth external sites (#1295) 2020-05-28 10:53:57 +02:00
webpack.config.renderer.js [MM-19856] Add back button when navigating outside of MM server (#1179) 2020-03-19 21:51:26 +01: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 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.