custom mattermost desktop application

Go to file

Sven Huester fa961654f3 fixes several typos		2018-12-02 14:55:24 +01:00
.circleci	Execute lint after packaging in CircleCI	2018-08-01 23:06:13 +09:00
.github/ISSUE_TEMPLATE	Update bug_report.md	2018-05-22 09:37:47 -04:00
builds/pr	basic jenkinsfile for pull requests	2018-05-04 01:20:53 -04:00
docs	fixes several typos	2018-12-02 14:55:24 +01:00
resources	Bundle Mac Desktop App in DMG	2018-06-23 22:53:52 -05:00
scripts	Tweak artifact name for release	2018-11-26 23:49:59 +09:00
src	fixes several typos	2018-12-02 14:55:24 +01:00
test	fixes several typos	2018-12-02 14:55:24 +01:00
.babelrc	Add CTRL+F shortcut to work as browser search	2018-07-06 12:21:06 +05:30
.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	Update .eslintrc-webapp.json with webapp-v4.10.0	2018-05-30 00:29:39 +09:00
.eslintrc.json	Remove findDOMNode() from components	2018-09-06 00:30:17 +09:00
.gitignore	add build files and npm files to gitignore	2017-09-07 10:14:43 -07:00
CHANGELOG.md	Add UNDER DEVELOPMENT section to CHANGELOG.md	2018-11-27 22:29:36 +09:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2018-05-25 00:05:47 +09:00
electron-builder.json	added flag for AppImage packaging	2018-09-22 09:10:41 +02:00
ISSUE_TEMPLATE.md	Tweak ISSUE_TEMPLATE.md	2018-03-13 00:50:42 +09:00
LICENSE.txt	Change app author to Mattermost	2017-07-10 22:19:37 +09:00
NOTICE.txt	Update NOTICE.txt	2018-10-31 14:17:47 -07:00
package.json	Start v4.3.0-develop	2018-11-27 22:27:09 +09: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	2018-07-11 21:14:38 +02:00
TESTING.md	Update TESTING.md	2017-11-17 11:31:35 -05:00
webpack.config.base.js	Fix ESLint header/header error	2018-05-31 00:30:24 +09:00
webpack.config.main.js	Fix ESLint header/header error	2018-05-31 00:30:24 +09:00
webpack.config.renderer.js	Add CTRL+F shortcut to work as browser search	2018-07-06 12:21:06 +05:30
yarn.lock	Upgrade Electron to 2.0.12	2018-10-28 23:12:54 +09: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.

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.

Download a file from the downloads page.
Launch Mattermost in the unarchived folder.
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.