README.md

Mattermost Desktop

Mattermost is an open source platform for secure collaboration across the entire software development lifecycle. This repo is for the native desktop application that's built on Electron; it runs on Windows, Mac, and Linux.

Originally created as "electron-mattermost" by Yuya Ochiai.

Features

Desktop integration

• Server dropdown for access to multiple teams
• Dedicated tabs for Channels, Boards and Playbooks
• Desktop Notifications
• Badges for unread channels and mentions
• Deep Linking to open Mattermost links directly in the app
• Runs in background to reduce number of open windows

Usage

Installation

Detailed guides are available at docs.mattermost.com.

1. Download a file from the downloads page or from the releases page.
2. Run the installer or unzip the archive.
3. Launch Mattermost from your Applications folder, menu, or the unarchived folder.
4. On the first launch, please enter a name and URL for your Mattermost server. For example, https://mattermost.example.com.

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

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.

Development and Making Contributions

Our developer guide has detailed information on how to set up your development environment, develop, and test changes to the Desktop App.