Mattermost Desktop application for Windows, Mac and Linux
JavaScript Shell Other

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.

Mattermost Desktop Screenshot

Circle CI

Features

Desktop integration

  • Tabs for multiple teams across multiple servers
  • Desktop Notifications
    • Windows 10: Toast
    • Windows 7-8.1: Balloon (fallback behavior, so lesser support)
    • 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. After first launching, please input name and URL for your Mattermost team. For example, myteam : https://mattermost.example.com/team.

Quit

Ctrl or Command + Q to quit.

Configuration

You can show the dialog from menu bar. (Please press Alt key to show the menu bar if it disappers.)

Configuration will be saved into Electron's userData directory:

  • %APPDATA%\Mattermost on Windows
  • ~/Library/Application Support/Mattermost on OS X
  • ~/.config/Mattermost 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 proxy. Or you can set proxy by following command line options.

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

Contributing

Please see CONTRIBUTING.md.

Development

Please see docs/development.md.