2016-12-05 06:45:35 -08:00
# Mattermost Desktop for Linux
## Table of Contents
- [Install ](#install )
2016-12-06 09:53:47 -08:00
- [User Guide ](#user-guide )
2016-12-05 06:45:35 -08:00
- [Contributing ](#contributing )
- [License ](#license )
## Install
2016-12-06 09:53:47 -08:00
If you installed the application via a package manager, it's ready to use in your system. Please follow the [User Guide ](#user-guide ) for further information.
2016-12-05 06:45:35 -08:00
2016-12-06 09:53:47 -08:00
Otherwise, first locate the extracted directory in your desired directory (e.g. `/opt/mattermost-desktop-<VERSION>` ) and follow the steps below.
2016-12-05 06:45:35 -08:00
### Desktop launcher
2016-12-06 09:53:47 -08:00
Execute the script file to create a `Mattermost.desktop` file.
2016-12-05 06:45:35 -08:00
```
/opt/mattermost-desktop-< VERSION > /create_desktop_file.sh
```
2016-12-06 09:53:47 -08:00
Then move it to the appropriate directory of your desktop environment. For example, on Ubuntu Unity it's `~/.local/share/applications/` for the current user.
2016-12-05 06:45:35 -08:00
```
mv Mattermost.desktop ~/.local/share/applications/
```
### Terminal command
2016-12-06 09:53:47 -08:00
Set a `PATH` environment variable to enable launching from the terminal. For example, you can append the following line into `~/.bashrc` .
2016-12-05 06:45:35 -08:00
```sh
# assuming that /opt/mattermost-desktop-<VERSION>/mattermost-desktop is the executable file.
export PATH=$PATH:/opt/mattermost-desktop-< VERSION >
```
Alternatively, you can also create a symbolic link for the application.
```sh
sudo ln -s /opt/mattermost-desktop-< VERSION > /mattermost-desktop /usr/local/bin/
```
2016-12-06 09:53:47 -08:00
You're now all set! See the [User Guide ](#user-guide ) below for instructions.
## User Guide
2016-12-05 06:45:35 -08:00
After launching, you need to configure the application to interact with your team.
2016-12-06 09:53:47 -08:00
1. If you don't see a page titled "Settings", select **File** > **Settings...** from the menu bar.
2016-12-05 06:45:35 -08:00
2. Click **Add new team** next to the right of Team Management section.
3. Enter **Name** and a valid **URL** , which begins with either `http://` or `https://` .
4. Click **Add** .
2016-12-07 03:25:30 -08:00
5. Click **Save** .
2016-12-05 06:45:35 -08:00
2016-12-06 09:53:47 -08:00
More guides are available at [Mattermost Documentation ](https://docs.mattermost.com/help/apps/desktop-guide.html ).
2016-12-05 06:45:35 -08:00
## Contributing
2016-12-07 05:07:52 -08:00
See [contributing guidelines ](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md ) for reporting bugs, features or submitting pull requests.
2016-12-05 06:45:35 -08:00
## License
2016-12-07 07:10:29 -08:00
Apache License, Version 2.0