2016-03-11 07:22:06 -08:00
|
|
|
# Mattermost Desktop (beta)
|
2015-10-24 05:53:17 -07:00
|
|
|
|
2016-03-10 04:46:47 -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
|
|
|
|
2016-03-12 07:28:11 -08:00
|
|
|
|
2016-03-11 08:06:39 -08:00
|
|
|
|
2016-03-09 09:02:36 -08:00
|
|
|
|
2016-03-12 07:06:46 -08: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
|
|
|
|
|
* Windows 7-8.1: Balloon (fallback behavior, so lesser support)
|
|
|
|
|
* 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
|
2016-01-16 00:10:37 -08:00
|
|
|
Detailed guides are available at [docs/setup.md](docs/setup.md).
|
|
|
|
|
|
2016-03-15 04:44:26 -07:00
|
|
|
1. Download and unarchive a file from [release page](http://github.com/mattermost/desktop/releases).
|
|
|
|
|
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`.
|
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.
|
2016-03-15 04:44:26 -07:00
|
|
|
(Please press Alt key to show the menu bar if it disappers.)
|
2015-12-27 00:20:56 -08:00
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
*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
|
2016-03-09 03:52:00 -08:00
|
|
|
Normally, the application will follow your system settings to use proxy.
|
|
|
|
|
Or you can set proxy by following command line options.
|
2016-03-06 05:13:30 -08:00
|
|
|
|
|
|
|
|
* `--proxy-server=<SERVER>:<PORT>`
|
|
|
|
|
* `--proxy-pac-url=<URL>`
|
|
|
|
|
|
2015-11-14 04:23:27 -08:00
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
## Testing and Development
|
2015-11-03 03:49:53 -08:00
|
|
|
Node.js is required to test this app.
|
|
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
### Simple testing
|
2015-11-03 03:49:53 -08:00
|
|
|
1. Clone or download the source code.
|
|
|
|
|
2. Run `npm install`.
|
2015-12-25 07:02:19 -08:00
|
|
|
3. Run `npm start`.
|
2015-11-09 07:35:35 -08:00
|
|
|
|
2016-02-09 03:59:52 -08:00
|
|
|
When you edit `src/**` files, please execute `npm run build` before `npm start`.
|
2015-11-14 04:23:27 -08:00
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
### Development
|
2016-03-09 22:53:51 -08:00
|
|
|
###### `npm run watch`
|
2015-12-25 07:02:19 -08:00
|
|
|
Reload the app automatically when you have saved source codes.
|
2015-11-09 07:35:35 -08:00
|
|
|
|
2016-03-09 22:53:51 -08:00
|
|
|
###### `npm test`
|
2015-12-25 07:02:19 -08:00
|
|
|
Run tests with Mocha.
|
2015-11-09 07:35:35 -08:00
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
## Packaging
|
2015-11-09 07:35:35 -08:00
|
|
|
You can package this app with following commands. Packages will be created in `release` directory.
|
|
|
|
|
|
|
|
|
|
```
|
2015-12-25 07:02:19 -08:00
|
|
|
$ npm run package (for your platform)
|
|
|
|
|
$ npm run package:windows (Requires Windows or Wine)
|
|
|
|
|
$ npm run package:osx (Requires OS X or Linux)
|
|
|
|
|
$ npm run package:linux
|
|
|
|
|
$ npm run package:all (Packages for all platform)
|
2015-11-09 07:35:35 -08:00
|
|
|
```
|
2016-03-11 07:22:06 -08:00
|
|
|
|
2016-05-13 12:47:30 -07:00
|
|
|
Create a windows installer with the following command. It will appear in the `release\windows-installer` directory.
|
|
|
|
|
```
|
|
|
|
|
$ npm run installer
|
|
|
|
|
```
|
|
|
|
|
|
2016-03-11 07:22:06 -08:00
|
|
|
## Contributing
|
|
|
|
|
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).
|
