2016-10-01 10:26:08 -07:00
# Mattermost Desktop
2015-10-24 05:53:17 -07:00
2018-01-19 06:49:59 -08:00
Native desktop application for [Mattermost ](http://www.mattermost.org/ ) running on Windows, Mac, and Linux.
2016-03-09 09:02:36 -08:00
2016-03-10 04:46:47 -08:00
Originally created as "electron-mattermost" by Yuya Ochiai. Developed using [Electron ](http://electron.atom.io/ ).
2016-03-09 09:02:36 -08:00
2018-01-19 12:00:30 -08:00
2016-03-09 09:02:36 -08:00
2017-09-15 07:58:50 -07:00
[](https://circleci.com/gh/mattermost/desktop)
2015-11-14 04:23:27 -08:00
2015-11-03 03:49:53 -08:00
## Features
2015-11-14 04:23:27 -08:00
### Desktop integration
2016-03-10 04:46:47 -08:00
* Tabs for multiple teams across multiple servers
2016-03-09 22:53:51 -08:00
* Desktop Notifications
2016-02-18 07:41:59 -08:00
* Windows 10: Toast
2018-04-09 06:40:46 -07:00
* Windows 7-8.1: Popup like Toast
2016-02-18 07:41:59 -08:00
* OS X: Notification Center
2016-03-09 22:53:51 -08:00
* Linux: [libnotify ](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux )
* Badges for unread channels and mentions
2016-03-10 04:46:47 -08:00
* Installs as native application
2015-11-14 04:23:27 -08:00
### Pre-packaged
You don't have to install any other software.
2016-03-15 04:44:26 -07:00
Packages are available on the [releases page ](http://github.com/mattermost/desktop/releases ).
2015-11-03 03:49:53 -08:00
## Usage
2015-11-14 04:23:27 -08:00
### Installation
2017-11-17 07:13:45 -08:00
Detailed guides are available at [docs.mattermost.com ](https://about.mattermost.com/default-desktop-app-documentation/ ).
2016-01-16 00:10:37 -08:00
2016-10-01 10:26:08 -07:00
1. Download a file from the [downloads page ](https://about.mattermost.com/downloads ).
2016-03-15 04:44:26 -07:00
2. Launch `Mattermost` in the unarchived folder.
2018-04-09 06:55:49 -07:00
3. On the first launch, please input name and URL for your Mattermost server. For example, `myserver : https://mattermost.example.com` .
2015-11-03 03:49:53 -08:00
2015-11-14 04:23:27 -08:00
### Quit
Ctrl or Command + Q to quit.
### Configuration
2015-12-27 00:20:56 -08:00
You can show the dialog from menu bar.
2015-11-03 03:49:53 -08:00
Configuration will be saved into Electron's userData directory:
2016-03-15 04:44:26 -07:00
* `%APPDATA%\Mattermost` on Windows
* `~/Library/Application Support/Mattermost` on OS X
* `~/.config/Mattermost` on Linux
2018-04-25 12:54:20 -07:00
A custom data directory location can be specified with:
2018-07-11 12:14:38 -07:00
* `Mattermost.exe --args --data-dir C:\my-mattermost-data` on Windows
2018-04-25 12:54:20 -07:00
* `open /Applications/Mattermost.app/ --args --data-dir ~/my-mattermost-data/` on macOS
* `./mattermost-desktop --args --data-dir ~/my-mattermost-data/` on Linux
2016-03-15 04:44:26 -07:00
*When you upgrade from electron-mattermost, please copy `config.json` from `electron-mattermost` .
Otherwise, you have to configure again.*
2015-11-03 03:49:53 -08:00
2016-03-06 05:13:30 -08:00
### Proxy
2018-04-09 06:55:49 -07:00
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.
2016-03-06 05:13:30 -08:00
* `--proxy-server=<SERVER>:<PORT>`
* `--proxy-pac-url=<URL>`
2018-04-09 06:48:16 -07:00
On Windows, please make sure to add `--` before options. For example, `Mattermost.exe -- --proxy-server=...` .
2018-04-09 06:40:46 -07:00
2019-04-18 09:37:20 -07:00
## Custom App Deployments
Our [docs provide a guide ](https://docs.mattermost.com/deployment/desktop-app-deployment.html ) 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.
2016-03-11 07:22:06 -08:00
## Contributing
Please see [CONTRIBUTING.md ](./CONTRIBUTING.md ).
2016-09-25 03:45:52 -07:00
## Development
Please see [docs/development.md ](./docs/development.md ).
2019-04-18 09:37:20 -07:00
