Using "Extract All..." with the default options will extract the files to the Downloads folder. Many users will do exactly that and end up running Mattermost from there downloads folder. Not a good thing. These instructions tell users where to extract the files. Perhaps in a future release these instructions can be reduced to run a batch script or installer.
5.9 KiB
Mattermost Desktop Setup Guides
Step-by-step Windows setup
To set up the Mattermost desktop application for Windows 7, 8 and 10:
-
Download the latest release of Mattermost Desktop
Find the file ending in
-win64.zip
if you're running a x64 version of Windows and-win32.zip
if you're running an older 32-bit version. -
From the
\Downloads
directory right-click on the file and select "Extract All..."- Change the extract folder from
C:\Users\(currentuser)\Downloads\mattermost-desktop-1.1.1-win64
toC:\Users\(currentuser)\AppData\Local
where(currentuser)
will be the name of your user account. - Check the "Show extracted files when complete" checkbox.
- Click the "Extract" button.
- Look for the new application directory at
C:\Users\(currentuser)\AppData\Local\mattermost-desktop...
. - Remove the version number by renaming the
mattermost-desktop...
application directory tomattermost-desktop
. - If a
mattermost-desktop
directory already exists then you are upgrading Mattermost, and need to quit Mattermost if it is running and then delete themattermost-desktop
directory. After that you can rename themattermost-desktop...
directory tomattermost-desktop
. Don't worry, no settings will be lost, they are stored elsewhere.
- Change the extract folder from
-
Go to the
\mattermost-desktop
application directory and find the file namedMattermost
.- Right-click the file and select "Pin to Taskbar" to make the application available from your Windows task bar.
- Right-click the file and select "Pin to Start Menu" to make the application available from your Windows Start menu.
- Double-click the file to open the application.
-
After opening the application, press
Alt
key to bring up the menu at the top of the window, then clickFile -> Settings
-
For each Mattermost team you'd like to use, enter its Name and URL then click Add
-
Click Save to save your setting
You're now ready to use electron-mattermost to interact with multiple teams from one desktop application
To quit, use
Ctrl+Q
Help
The Mattermost desktop application offers:
- Connectivity to one or more Mattermost team sites and multiple Mattermost servers
- Shortcuts from Start Menu and Windows Task Bar
- Icon notifications from Windows Task Bar
- Desktop notifications
See the Mattermost help documention for how to use the Mattermost team site.
Settings Page
The Settings Page is available from the File menu under Settings (Click Alt
to show the menu if it's not visible). This page manages connections to team sites and other settings.
- Add a Team Site:
- Under Teams section, enter Name for team name to show in top tab
- Enter URL for the team site location. For example:
https://example.com/teamname
then click Add.
- Delete a Team Site:
- Delete a Team Site by clicking the "x" next to the URL of the team site you wish to delete.
- Hide Menu Bar
- Under Options enable this option to hide the menu bar. Press "Alt" to show the Menu Bar.
Menu Bar
If Hide Menu Bar option is enabled, click the Alt
key to toggle the menu on and off.
Below lists menu options (shortcut keys are listed in brackets):
- File
- About Mattermost - Shows version information for Mattermost desktop application
- Settings - Opens setting menu to add new team sites and configure shortcut key options
- Quit (Ctrl+Q) - Exits the application
- Edit
- Undo (Ctrl+Z) - Reverses previous action
- Redo (Ctrl+Shift+Z) - Replays most recent action
- Cut (Ctrl+X) - Cuts selected text
- Copy (Ctrl+C) - Copies selected text
- Paste (Ctrl+V) - Pastes text from clipboard
- Select All (Ctrl+A) - Select all text in input box
- View
- Reload (Ctrl+R) - Reload page from the server
- Clear Cache and Reload (Ctrl+Shift+R) - Clear cached content in application and reload page
- Toggle Full Screen (F11) - Toggle application from window to full screen and back
- Toggle Developer Tools (Ctrl+Shift+I) - Turn on and off sidebar showing developer tools
Notifications
Mattermost lets users configure desktop notifications to alert users to new events in a team site.
For the Mattermost Windows application, these appear as ballon notifications from the task bar on Windows 7 and Windows 8.1, and as a "toast" pop-up on Windows 10.
Start Menu and Task Bar shortcuts
If pinned to the Windows Start Menu in Step 3 of the setup procedure, a shortcut to the Mattermost desktop application should be available from the Start Menu by pressing the Windows Key.
If pinned to the Windows Task Bar in Step 3 of the setup procedure, a shortcut to the Mattermost desktop application should be available from the Windows Task Bar.
Step-by-step OS X setup
For OS X 10.11 El Capitan. An older version of OS X has similar way.
-
Download the latest release of Mattermost Desktop
Find the file ending in
-osx.tar.gz
. -
From the
/Downloads
directory double-click on the file."A new directory should be created on your Mac.
-
Go to
/mattermost-desktop...
directory and right-click onMattermost
package and select "Open"If you see a dialog to confirm the application, select "Open".
You should see a new application called Mattermost Desktop open.
-
Click
Mattermost
from the menu at the top of the screen, then clickSettings
-
For each Mattermost team you'd like to use, enter its Name and URL then click Add
-
Click Save to save your setting
You're now ready to use electron-mattermost to interact with multiple teams from one desktop application
To quit, use
Command+Q