custom mattermost desktop application

Go to file

Derrick Anderson 0796a9395b basic jenkinsfile for pull requests		2018-05-04 01:20:53 -04:00
.circleci	Build storybook as CircleCI artifacts	2018-04-12 23:09:55 +09:00
builds/pr	basic jenkinsfile for pull requests	2018-05-04 01:20:53 -04:00
docs	Merge pull request #704 from yuya-oc/docs-build-config	2018-03-30 00:27:46 +09:00
resources	Workaround for Linux icon	2018-04-02 21:59:47 +09:00
scripts	Use ES6 import/export for modules	2018-04-10 22:00:30 +09:00
src	Merge pull request #775 from Autre31415/fix-linting	2018-04-30 20:22:20 +09:00
test	Tweak timeout	2018-04-12 23:01:46 +09:00
.babelrc	Upgrade Electron to 1.8.2	2018-02-14 22:38:41 +09: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	Upgrade ESLint and rules	2018-02-23 00:31:18 +09:00
.eslintrc.json	Use ES6 import/export for modules	2018-04-10 22:00:30 +09:00
.gitignore	add build files and npm files to gitignore	2017-09-07 10:14:43 -07:00
CHANGELOG.md	Update CHANGELOG.md	2018-04-30 20:24:33 +09:00
CONTRIBUTING.md	Update docs for eslint	2016-10-28 01:16:27 +09:00
electron-builder.json	Tweak linux icon for tar.gz	2018-04-06 00:25:43 +09: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 to use MIT of React	2018-02-23 00:46:16 +09:00
package.json	Update version to 4.1.0	2018-04-24 21:56:48 +09:00
PULL_REQUEST_TEMPLATE.md	Update PULL_REQUEST_TEMPLATE.md for eslint	2016-11-07 22:00:21 +09:00
README.md	Adds docs about using a custom data directory.	2018-04-25 15:54:20 -04:00
TESTING.md	Update TESTING.md	2017-11-17 11:31:35 -05:00
webpack.config.base.js	Fix eslint error	2018-04-10 22:00:31 +09:00
webpack.config.main.js	Fix eslint error	2018-04-10 22:00:31 +09:00
webpack.config.renderer.js	Fix eslint error	2018-04-10 22:00:31 +09:00
yarn.lock	Use Storybook to preview React components	2018-04-11 21:55:29 +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 -- --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.