Mattermost Desktop application for Windows, Mac and Linux
Clone or download
Permalink
Failed to load latest commit information.
.circleci Execute lint after packaging in CircleCI Aug 1, 2018
.github/ISSUE_TEMPLATE Update bug_report.md May 22, 2018
builds/pr basic jenkinsfile for pull requests May 4, 2018
docs Merge pull request #836 from mattermost/MM-10322 Aug 1, 2018
resources Bundle Mac Desktop App in DMG Jun 24, 2018
scripts Tweak artifact name Jun 6, 2018
src Merge pull request #861 from yuya-oc/no-find-dom-node Sep 19, 2018
test Add pt-BR spell checker Jul 30, 2018
.babelrc Add CTRL+F shortcut to work as browser search Jul 6, 2018
.editorconfig Force to use LF and add editorconfig Feb 25, 2016
.eslintignore Fix tests Mar 6, 2017
.eslintrc-webapp.json Update .eslintrc-webapp.json with webapp-v4.10.0 May 29, 2018
.eslintrc.json Remove findDOMNode() from components Sep 5, 2018
.gitignore add build files and npm files to gitignore Sep 7, 2017
CHANGELOG.md Update CHANGELOG.md Sep 12, 2018
CONTRIBUTING.md Update CONTRIBUTING.md May 24, 2018
ISSUE_TEMPLATE.md Tweak ISSUE_TEMPLATE.md Mar 12, 2018
LICENSE.txt Change app author to Mattermost Jul 10, 2017
NOTICE.txt Update NOTICE.txt Sep 21, 2018
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md for eslint Nov 7, 2016
README.md Update README.md Jul 11, 2018
TESTING.md Update TESTING.md Nov 17, 2017
electron-builder.json Bundle Mac Desktop App in DMG Jun 24, 2018
package.json Upgrade Electron to 2.0.8 Aug 23, 2018
webpack.config.base.js Fix ESLint header/header error May 30, 2018
webpack.config.main.js Fix ESLint header/header error May 30, 2018
webpack.config.renderer.js Add CTRL+F shortcut to work as browser search Jul 6, 2018
yarn.lock Upgrade Electron to 2.0.8 Aug 23, 2018

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=....

Contributing

Please see CONTRIBUTING.md.

Development

Please see docs/development.md.