About Mattermost client
Minimize distractions and reduce context switching between your GitHub code repositories and your communication platform by integrating GitHub with Mattermost. Help your teams stay focused and productive with real-time updates on commits, pull requests, issues, and more directly from Mattermost channels.Setup#Setup starts in GitHub and configuration ends in Mattermost.Register an OAuth app in GitHub#A Mattermost system admin must perform the following steps in GitHub.Go to to register an OAuth app with GitHub.Set the following values:Application name: Mattermost GitHub Plugin - COMPANY NAME>Homepage URL: callback URL: replacing with your Mattermost URL. This value must match the Mattermost server URL you use to log in.Save your changes.Select Generate a new client secret, and enter your GitHub password to continue.Copy the Client ID and Client Secret in the resulting screen.In Mattermost, go to System Console > Plugins > GitHub, and regenerate both a Webhook Secret and At Rest Encryption Key by selecting Regenerate next to each field. You’ll need a copy of the Webhook Secret value to create a webhook in GitHub.NoteWe recommend making a copy of your webhook secret and encryption key, as it will only be visible to you once.Create a webhook in GitHub#A Mattermost system admin must perform the following steps in GitHub. Create a webhook in GitHub for each GitHub organization you want to set up.In GitHub, go to the Settings page where you want to send notifications from, then select Webhooks in the sidebar.Select Add Webhook.Set the following values:Payload URL: Replace with your Mattermost URL.Content Type: application/jsonSecret: The Webhook Secret value you copied earlier.Under Which events would you like to trigger this webhook?, select Let me select individual events.Select the following events:Branch or Tag creationBranch or Tag deletionReleasesIssue commentsIssuesPull requestsPull request reviewPull request review commentsPushesStarsWorkflowsSelect Add Webhook to save your changes.Mattermost configuration#A Mattermost system admin must perform the
Key features of the Mattermost client that are enabled through these drivers include:
- Boards and playbooks on mobile client - Troubleshooting - Mattermost
- Failed to register rtcd client - Troubleshooting - Mattermost
- [SOLVED] Parameters for OAuth client - Troubleshooting - Mattermost
- Trigger client logout (by server) - Troubleshooting - Mattermost
- Repository Error regarding Mattermost Desktop Client for
- Client Error connecting to Gitlab - Troubleshooting - Mattermost
- Windows Mattermost client unexpected consistent session
Following steps in Mattermost.Confirm whether your Mattermost deployment has a github user account. If it exists, that account posts GitHub messages in channels by default, and the messages won’t include a BOT tag. You can change this account behavior to include a BOT tag by using one of the following methods:Convert the user account to a bot using mmctl user convert.Change the existing github username to something else. A new bot account called github is created the Mattermost server is restarted when the enable bot account creation configuration setting is enabled.Install the GitHub integration from the in-product App Marketplace:In Mattermost, from the Product menu , select App Marketplace.Search for or scroll to GitHub, and select Install.Once installed, select Configure. You’re taken to the System Console.On the GitHub configuration page, enable and configure GitHub interoperability as follows, and then select Save:Enter the GitHub OAuth Client ID and GitHub OAuth Client Secret obtained during registration.(Optional) GitHub Organization: Lock the integration to a single GitHub organization by specifying the name of your GitHub organization.(GitHub Enterprise Only): Set Enterprise Base URL and Enterprise Upload URL values to your GitHub Enterprise URLs, e.g. These values are often the same.(Mattermost desktop app only) Display Notification Counters in Left Sidebar: Display or hide GitHub notification counters in the Mattermost sidebar.(Optional) Enable Private Repositories: Enable the ability to work with private repositories. Affected users are notified once private repositories are enabled, and must reconnect their GitHub accounts to gain access to private repositories.(Optional) Connect to private Repositories by default: Connect to private GitHub repositories by default, when private repositories are enabled.(Optional) Enable Code Previews: Expand permalinks to GitHub files with previews. You can can enable public repositories, public and private repositories, or disable this option.(Optional) Enable Webhook Event Logging: Log webhook events when log level set to DEBUG
