Skip to content

Latest commit

 

History

History
152 lines (87 loc) · 7.58 KB

INSTALL.md

File metadata and controls

152 lines (87 loc) · 7.58 KB
Raw

Install Guides

Server Install

Windows Client Install

1) Install Pidgin

Download and install Pidgin per instructions.

2) Install Pidgin-Mattermost

a) Download the plugin installer

Download the latest release of the Pidgin-Mattermost plugin from the releases page, which should be named Pidgin-Mattermost-v[VERSION_NUMBER].exe.

Notes:

  • This plugin is "open source" and its complete source code is publicly available for review and critique.. Because it is a program that runs on your computer, and because it does not bear the digital signature of a corporation, you may encounter warnings while installing to confirm you are intentionally installing the software and are aware of its origins.

  • Your browser may display a warning on download to the effect of: "Pidgin-Mattermost-v[VERSION_NUMBER].exe is not commonly downloaded and may be dangerous", you can confirm you understand the warning and select Keep from the menu button to continue.

b) Run the installer file

Double click on the .exe file you downloaded to start the installation.

  • You may see an "unrecognized app" warning. Click "More info" and "Run anyway" to continue and enter "Yes" to confirm when asked again.

c) On welcome screen click "Next" to continue

image

On the next screen, review and accept the standard open source license agreement, "GPLv3" if you wish to proceed. The full license file along with summary explaination is available online.

The following screen will show progress on the installation procedure:

image

The installer will install the Pidgin-Mattermost plugin, add the Mattermost icons to your Pidgin client, and either install the Pidgin Plugin Manager (libjson-glib-1.0.dll) if it's not yet installed, or upgrade the Plugin Manager if it is out-of-date.

d) If your plugin manager is out-dated, you may be asked to confirm you want to upgrade

Click OK to continue.

image

e) Click "Finish" after the installer is complete

You may optionally check "Run Pidgin" to start the application after completing the plugin installation.

image

3) Restart Pidgin

When the app is restarted, you should see a welcome screen from Pidgin with help instructions on how to get started:

4) Enter your Mattermost account

1) From the Pidgin Welcome Screen, click "Add..." to add an account

2) On the "Add Account" screen, under Protocol select "Mattermost" and enter credentials

Select Mattermost from the dropdown list under Protocol:

Enter:

  • Username: This may be an email address, username or AD/LDAP login attribute depending on how your Mattermost server is configured.
  • Server: Enter the name of your server WITHOUT https://
  • Password: Enter your password

Optional: Depending on your internal IT policy, optionally check "Remember password" if you'd like Pidgin to store the information.

When complete, click Add to complete the creation of your new Mattermost account. This should bring you back to the Accounts screen.

GitLab cookie (MMAUTHTOKEN) authentication workaround:

  • Login to your mattermost server with your browser.
  • Obtain the value of MMAUTHTOKEN cookie for your mattermost server. (on your Mattermost web page: right-click -> Inspect Element, under "Storage" open cookies and copy MMAUTHTOKEN content. It should look like "ewmxxxuxatndbjergsssizngry" )
  • Copy it to Password: field.
  • In Advanced account setup tab check Password is Gitlab cookie.

Note: MMAUTHTOKEN cookie expires after a server defined time: above procedure needs to be repeated each time it happens.

3) Sign-on to Mattermost

On the Accounts screen double-click on your Mattermost server to join.

Once you have joined, Pidgin's Buddy List should appear, and include a list of all subscribed open and private channels in Mattermost, including multi-person group message and direct message channels.

image

Right click and select Join to join the channel.

Use Accounts > {Mattermost Account} > Room List to add more chats and subscribe to more existing Mattermost open and private channels.

Use Accounts > {Mattermost Account} > Search for Users... to add more buddies and subscribe to direct messages Mattermost channels.

Note: Creating new public, private or group message channel is not implemented in the plugin yet: you will need to use Mattermost web or desktop client for this functionality for now.

The channel is linked to Mattermost and messages you post appear on the Mattermost server.

image

The members of the channel appear to the right of the conversation. Right-click and select IM to open a direct message channel with anyone in the room.

Linux Client Install Guide

For people using Debian-based distributions of Linux operating systems, you can install the Pidgin-Mattermost plug using the following commands from a terminal:

sudo apt-get install libpurple-dev libjson-glib-dev libglib2.0-dev git make libmarkdown2-dev build-essential;
git clone https://github.com/EionRobb/purple-mattermost.git && cd purple-mattermost;
make && sudo make install

For people using Red Hat/Fedora/CentOS distributions of Linux operating systems, you can build and install packaged version of the plugin using the following commands from a terminal:

sudo yum install rpm-build json-glib-devel libmarkdown-devel libpurple-devel mercurial
git clone https://github.com/EionRobb/purple-mattermost.git && cd purple-mattermost;
OLD_LANG=$LANG
LANG=en_US.UTF-8
make && make rpm
LANG=$OLD_LANG
sudo yum localinstall ./rpmdir/RPMS/\*/purple-mattermost-\*.rpm ./rpmdir/RPMS/\*/purple-mattermost-\*.rpm

MacOS X Client Install Guide

You will need XCode command line tools installed, then install Homebrew and package dependencies:

brew install json-glib pidgin discount --with-shared
git clone https://github.com/EionRobb/purple-mattermost.git && cd purple-mattermost;
make && sudo make install