mirror of
https://github.com/telekom-security/tpotce.git
synced 2025-04-29 19:58:52 +00:00
322 lines
23 KiB
Text
322 lines
23 KiB
Text
<!DOCTYPE html>
|
|
|
|
<html class="" lang="en">
|
|
<head prefix="og: http://ogp.me/ns#">
|
|
<meta charset="utf-8"/>
|
|
<meta content="IE=edge" http-equiv="X-UA-Compatible"/>
|
|
<meta content="object" property="og:type"/>
|
|
<meta content="GitLab" property="og:site_name"/>
|
|
<meta content="Mattermost slash commands · Integrations · Project · User · Help" property="og:title"/>
|
|
<meta content="GitLab Community Edition" property="og:description"/>
|
|
<meta content="http://172.20.254.127/assets/gitlab_logo-7ae504fe4f68fdebb3c2034e36621930cd36ea87924c11ff65dbcb8ed50dca58.png" property="og:image"/>
|
|
<meta content="64" property="og:image:width"/>
|
|
<meta content="64" property="og:image:height"/>
|
|
<meta content="http://172.20.254.127/help/user/project/integrations/mattermost_slash_commands.md" property="og:url"/>
|
|
<meta content="summary" property="twitter:card"/>
|
|
<meta content="Mattermost slash commands · Integrations · Project · User · Help" property="twitter:title"/>
|
|
<meta content="GitLab Community Edition" property="twitter:description"/>
|
|
<meta content="http://172.20.254.127/assets/gitlab_logo-7ae504fe4f68fdebb3c2034e36621930cd36ea87924c11ff65dbcb8ed50dca58.png" property="twitter:image"/>
|
|
<title>Mattermost slash commands · Integrations · Project · User · Help · GitLab</title>
|
|
<meta content="GitLab Community Edition" name="description"/>
|
|
<link data-original-href="/assets/favicon-7901bd695fb93edb07975966062049829afb56cf11511236e61bcf425070e36e.png" href="/assets/favicon-7901bd695fb93edb07975966062049829afb56cf11511236e61bcf425070e36e.png" id="favicon" rel="shortcut icon" type="image/png"/>
|
|
<link href="/assets/application-266f2bfa52ff531258d13c702895a14fd5994ca591fa2df7338da00ab18c99ac.css" media="all" rel="stylesheet"/>
|
|
<link href="/assets/print-c8ff536271f8974b8a9a5f75c0ca25d2b8c1dceb4cff3c01d1603862a0bdcbfc.css" media="print" rel="stylesheet"/>
|
|
<script>
|
|
//<![CDATA[
|
|
window.gon={};gon.api_version="v4";gon.default_avatar_url="http://172.20.254.127/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png";gon.max_file_size=10;gon.asset_host=null;gon.webpack_public_path="/assets/webpack/";gon.relative_url_root="";gon.shortcuts_path="/help/shortcuts";gon.user_color_scheme="white";gon.gitlab_url="http://172.20.254.127";gon.revision="63daf37";gon.gitlab_logo="/assets/gitlab_logo-7ae504fe4f68fdebb3c2034e36621930cd36ea87924c11ff65dbcb8ed50dca58.png";gon.sprite_icons="/assets/icons-07542808fffaf82e9b57b144464ea42620b32f65ce441c01528d23d4b96d5f11.svg";gon.sprite_file_icons="/assets/file_icons-7262fc6897e02f1ceaf8de43dc33afa5e4f9a2067f4f68ef77dcc87946575e9e.svg";gon.emoji_sprites_css_path="/assets/emoji_sprites-289eccffb1183c188b630297431be837765d9ff4aed6130cf738586fb307c170.css";gon.test_env=false;gon.suggested_label_colors=["#0033CC","#428BCA","#44AD8E","#A8D695","#5CB85C","#69D100","#004E00","#34495E","#7F8C8D","#A295D6","#5843AD","#8E44AD","#FFECDB","#AD4363","#D10069","#CC0033","#FF0000","#D9534F","#D1D100","#F0AD4E","#AD8D43"];
|
|
//]]>
|
|
</script>
|
|
<script defer="defer" src="/assets/webpack/runtime.9fcb75d4.bundle.js"></script>
|
|
<script defer="defer" src="/assets/webpack/main.a66b6c66.chunk.js"></script>
|
|
<script defer="defer" src="/assets/webpack/pages.help.show.c42c0700.chunk.js"></script>
|
|
<meta content="authenticity_token" name="csrf-param">
|
|
<meta content="4hgTA9XEc0eGHnB9YGgEMkzx0EdHvNDhPPrDp6aVKUvLRmRViUntbhR2xQekNhUPdg4TvmSZrM0pf6hzMWZLww==" name="csrf-token">
|
|
<meta content="origin-when-cross-origin" name="referrer"/>
|
|
<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport"/>
|
|
<meta content="#474D57" name="theme-color"/>
|
|
<link href="/assets/touch-icon-iphone-5a9cee0e8a51212e70b90c87c12f382c428870c0ff67d1eb034d884b78d2dae7.png" rel="apple-touch-icon" type="image/x-icon"/>
|
|
<link href="/assets/touch-icon-ipad-a6eec6aeb9da138e507593b464fdac213047e49d3093fc30e90d9a995df83ba3.png" rel="apple-touch-icon" sizes="76x76" type="image/x-icon"/>
|
|
<link href="/assets/touch-icon-iphone-retina-72e2aadf86513a56e050e7f0f2355deaa19cc17ed97bbe5147847f2748e5a3e3.png" rel="apple-touch-icon" sizes="120x120" type="image/x-icon"/>
|
|
<link href="/assets/touch-icon-ipad-retina-8ebe416f5313483d9c1bc772b5bbe03ecad52a54eba443e5215a22caed2a16a2.png" rel="apple-touch-icon" sizes="152x152" type="image/x-icon"/>
|
|
<link color="rgb(226, 67, 41)" href="/assets/logo-d36b5212042cebc89b96df4bf6ac24e43db316143e89926c0db839ff694d2de4.svg" rel="mask-icon"/>
|
|
<meta content="/assets/msapplication-tile-1196ec67452f618d39cdd85e2e3a542f76574c071051ae7effbfde01710eb17d.png" name="msapplication-TileImage"/>
|
|
<meta content="#30353E" name="msapplication-TileColor"/>
|
|
</meta></meta></head>
|
|
<body class="ui-indigo " data-group="" data-page="help:show" data-project="">
|
|
<header class="navbar navbar-gitlab qa-navbar navbar-expand-sm">
|
|
<a class="sr-only gl-accessibility" href="#content-body" tabindex="1">Skip to content</a>
|
|
<div class="container-fluid">
|
|
<div class="header-content">
|
|
<div class="title-container">
|
|
<h1 class="title">
|
|
<a href="/" id="logo" title="Dashboard"><svg class="tanuki-logo" height="24" viewbox="0 0 36 36" width="24">
|
|
<path class="tanuki-shape tanuki-left-ear" d="M2 14l9.38 9v-9l-4-12.28c-.205-.632-1.176-.632-1.38 0z" fill="#e24329"></path>
|
|
<path class="tanuki-shape tanuki-right-ear" d="M34 14l-9.38 9v-9l4-12.28c.205-.632 1.176-.632 1.38 0z" fill="#e24329"></path>
|
|
<path class="tanuki-shape tanuki-nose" d="M18,34.38 3,14 33,14 Z" fill="#e24329"></path>
|
|
<path class="tanuki-shape tanuki-left-eye" d="M18,34.38 11.38,14 2,14 6,25Z" fill="#fc6d26"></path>
|
|
<path class="tanuki-shape tanuki-right-eye" d="M18,34.38 24.62,14 34,14 30,25Z" fill="#fc6d26"></path>
|
|
<path class="tanuki-shape tanuki-left-cheek" d="M2 14L.1 20.16c-.18.565 0 1.2.5 1.56l17.42 12.66z" fill="#fca326"></path>
|
|
<path class="tanuki-shape tanuki-right-cheek" d="M34 14l1.9 6.16c.18.565 0 1.2-.5 1.56L18 34.38z" fill="#fca326"></path>
|
|
</svg>
|
|
<span class="logo-text d-none d-sm-block">
|
|
<svg viewbox="0 0 617 169" xmlns="http://www.w3.org/2000/svg"><path d="M315.26 2.97h-21.8l.1 162.5h88.3v-20.1h-66.5l-.1-142.4M465.89 136.95c-5.5 5.7-14.6 11.4-27 11.4-16.6 0-23.3-8.2-23.3-18.9 0-16.1 11.2-23.8 35-23.8 4.5 0 11.7.5 15.4 1.2v30.1h-.1m-22.6-98.5c-17.6 0-33.8 6.2-46.4 16.7l7.7 13.4c8.9-5.2 19.8-10.4 35.5-10.4 17.9 0 25.8 9.2 25.8 24.6v7.9c-3.5-.7-10.7-1.2-15.1-1.2-38.2 0-57.6 13.4-57.6 41.4 0 25.1 15.4 37.7 38.7 37.7 15.7 0 30.8-7.2 36-18.9l4 15.9h15.4v-83.2c-.1-26.3-11.5-43.9-44-43.9M557.63 149.1c-8.2 0-15.4-1-20.8-3.5V70.5c7.4-6.2 16.6-10.7 28.3-10.7 21.1 0 29.2 14.9 29.2 39 0 34.2-13.1 50.3-36.7 50.3m9.2-110.6c-19.5 0-30 13.3-30 13.3v-21l-.1-27.8h-21.3l.1 158.5c10.7 4.5 25.3 6.9 41.2 6.9 40.7 0 60.3-26 60.3-70.9-.1-35.5-18.2-59-50.2-59M77.9 20.6c19.3 0 31.8 6.4 39.9 12.9l9.4-16.3C114.5 6 97.3 0 78.9 0 32.5 0 0 28.3 0 85.4c0 59.8 35.1 83.1 75.2 83.1 20.1 0 37.2-4.7 48.4-9.4l-.5-63.9V75.1H63.6v20.1h38l.5 48.5c-5 2.5-13.6 4.5-25.3 4.5-32.2 0-53.8-20.3-53.8-63-.1-43.5 22.2-64.6 54.9-64.6M231.43 2.95h-21.3l.1 27.3v94.3c0 26.3 11.4 43.9 43.9 43.9 4.5 0 8.9-.4 13.1-1.2v-19.1c-3.1.5-6.4.7-9.9.7-17.9 0-25.8-9.2-25.8-24.6v-65h35.7v-17.8h-35.7l-.1-38.5M155.96 165.47h21.3v-124h-21.3v124M155.96 24.37h21.3V3.07h-21.3v21.3"></path></svg>
|
|
</span>
|
|
</a></h1>
|
|
<ul class="list-unstyled navbar-sub-nav">
|
|
<li class="home"><a class="dashboard-shortcuts-projects" href="/explore" title="Projects">Projects
|
|
</a></li><li class=""><a class="dashboard-shortcuts-groups" href="/explore/groups" title="Groups">Groups
|
|
</a></li><li class=""><a class="dashboard-shortcuts-snippets" href="/explore/snippets" title="Snippets">Snippets
|
|
</a></li><li>
|
|
<a href="/help" title="About GitLab CE">Help</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li class="nav-item d-none d-sm-none d-md-block m-auto">
|
|
<div class="search search-form">
|
|
<form accept-charset="UTF-8" action="/search" class="form-inline" method="get"><input name="utf8" type="hidden" value="✓"/><div class="search-input-container">
|
|
<div class="search-input-wrap">
|
|
<div class="dropdown" data-url="/search/autocomplete">
|
|
<input aria-label="Search" autocomplete="off" class="search-input dropdown-menu-toggle no-outline js-search-dashboard-options" data-issues-path="/dashboard/issues" data-mr-path="/dashboard/merge_requests" id="search" name="search" placeholder="Search" spellcheck="false" tabindex="1" type="search"/>
|
|
<button class="hidden js-dropdown-search-toggle" data-toggle="dropdown" type="button"></button>
|
|
<div class="dropdown-menu dropdown-select">
|
|
<div class="dropdown-content"><ul>
|
|
<li class="dropdown-menu-empty-item">
|
|
<a>
|
|
Loading...
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</div><div class="dropdown-loading"><i aria-hidden="true" class="fa fa-spinner fa-spin" data-hidden="true"></i></div>
|
|
</div>
|
|
<svg class="s16 search-icon"><use xlink:href="/assets/icons-07542808fffaf82e9b57b144464ea42620b32f65ce441c01528d23d4b96d5f11.svg#search"></use></svg>
|
|
<svg class="s16 clear-icon js-clear-input"><use xlink:href="/assets/icons-07542808fffaf82e9b57b144464ea42620b32f65ce441c01528d23d4b96d5f11.svg#close"></use></svg>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<input class="js-search-group-options" id="group_id" name="group_id" type="hidden"/>
|
|
<input class="js-search-project-options" id="search_project_id" name="project_id" type="hidden" value=""/>
|
|
<input id="repository_ref" name="repository_ref" type="hidden"/>
|
|
<div class="search-autocomplete-opts hide" data-autocomplete-path="/search/autocomplete"></div>
|
|
</form></div>
|
|
</li>
|
|
<li class="nav-item d-inline-block d-sm-none d-md-none">
|
|
<a aria-label="Search" data-container="body" data-placement="bottom" data-toggle="tooltip" href="/search" title="Search"><svg class="s16"><use xlink:href="/assets/icons-07542808fffaf82e9b57b144464ea42620b32f65ce441c01528d23d4b96d5f11.svg#search"></use></svg>
|
|
</a></li>
|
|
<li class="nav-item">
|
|
<div>
|
|
<a class="btn btn-sign-in" href="/users/sign_in?redirect_to_referer=yes">Sign in / Register</a>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<button class="navbar-toggler d-block d-sm-none" type="button">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<svg class="s12 more-icon js-navbar-toggle-right"><use xlink:href="/assets/icons-07542808fffaf82e9b57b144464ea42620b32f65ce441c01528d23d4b96d5f11.svg#more"></use></svg>
|
|
<svg class="s12 close-icon js-navbar-toggle-left"><use xlink:href="/assets/icons-07542808fffaf82e9b57b144464ea42620b32f65ce441c01528d23d4b96d5f11.svg#close"></use></svg>
|
|
</button>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="layout-page">
|
|
<div class="content-wrapper">
|
|
<div class="mobile-overlay"></div>
|
|
<div class="alert-wrapper">
|
|
<nav class="breadcrumbs container-fluid container-limited" role="navigation">
|
|
<div class="breadcrumbs-container">
|
|
<div class="breadcrumbs-links js-title-container">
|
|
<ul class="list-unstyled breadcrumbs-list js-breadcrumbs-list">
|
|
<li><a href="/help">Help</a><svg class="s8 breadcrumbs-list-angle"><use xlink:href="/assets/icons-07542808fffaf82e9b57b144464ea42620b32f65ce441c01528d23d4b96d5f11.svg#angle-right"></use></svg></li>
|
|
<li>
|
|
<h2 class="breadcrumbs-sub-title"><a href="/help/user/project/integrations/mattermost_slash_commands.md">Help</a></h2>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div class="flash-container flash-container-page">
|
|
</div>
|
|
</div>
|
|
<div class="container-fluid container-limited ">
|
|
<div class="content" id="content-body">
|
|
<div class="documentation wiki prepend-top-default">
|
|
<h1 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#mattermost-slash-commands" id="user-content-mattermost-slash-commands"></a>Mattermost slash commands</h1>
|
|
<blockquote dir="auto">
|
|
<p>Introduced in GitLab 8.14</p>
|
|
</blockquote>
|
|
<p dir="auto">Mattermost commands give users an extra interface to perform common operations
|
|
from the chat environment. This allows one to, for example, create an issue as
|
|
soon as the idea was discussed in Mattermost.</p>
|
|
<h2 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#prerequisites" id="user-content-prerequisites"></a>Prerequisites</h2>
|
|
<p dir="auto">Mattermost 3.4 and up is required.</p>
|
|
<p dir="auto">If you have the Omnibus GitLab package installed, Mattermost is already bundled
|
|
in it. All you have to do is configure it. Read more in the
|
|
<a href="https://docs.gitlab.com/omnibus/gitlab-mattermost/" rel="nofollow noreferrer noopener" target="_blank">Omnibus GitLab Mattermost documentation</a>.</p>
|
|
<h2 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#automated-configuration" id="user-content-automated-configuration"></a>Automated Configuration</h2>
|
|
<p dir="auto">If Mattermost is installed on the same server as GitLab, the configuration process can be
|
|
done for you by GitLab.</p>
|
|
<p dir="auto">Go to the Mattermost Slash Command service on your project and click the 'Add to Mattermost' button.</p>
|
|
<h2 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#manual-configuration" id="user-content-manual-configuration"></a>Manual Configuration</h2>
|
|
<p dir="auto">The configuration consists of two parts. First you need to enable the slash
|
|
commands in Mattermost and then enable the service in GitLab.</p>
|
|
<h3 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#step-1-enable-custom-slash-commands-in-mattermost" id="user-content-step-1-enable-custom-slash-commands-in-mattermost"></a>Step 1. Enable custom slash commands in Mattermost</h3>
|
|
<p dir="auto">This step is only required when using a source install, omnibus installs will be
|
|
preconfigured with the right settings.</p>
|
|
<p dir="auto">The first thing to do in Mattermost is to enable custom slash commands from
|
|
the administrator console.</p>
|
|
<ol dir="auto">
|
|
<li>
|
|
<p>Log in with an account that has admin privileges and navigate to the system
|
|
console.</p>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_goto_console.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost go to console" class="lazy" data-src="img/mattermost_goto_console.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
<hr/>
|
|
</li>
|
|
<li>
|
|
<p>Click <strong>Custom integrations</strong> and set <strong>Enable Custom Slash Commands</strong>,
|
|
<strong>Enable custom integrations to override usernames</strong>, and <strong>Override
|
|
custom integrations to override profile picture icons</strong> to true</p>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_console_integrations.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost console" class="lazy" data-src="img/mattermost_console_integrations.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
<hr/>
|
|
</li>
|
|
<li>
|
|
<p>Click <strong>Save</strong> at the bottom to save the changes.</p>
|
|
</li>
|
|
</ol>
|
|
<h3 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#step-2-open-the-mattermost-slash-commands-service-in-gitlab" id="user-content-step-2-open-the-mattermost-slash-commands-service-in-gitlab"></a>Step 2. Open the Mattermost slash commands service in GitLab</h3>
|
|
<ol dir="auto">
|
|
<li>
|
|
<p>Open a new tab for GitLab, go to your project's
|
|
<a href="project_services.md#accessing-the-project-services">Integrations page</a>
|
|
and select the <strong>Mattermost command</strong> service to configure it.
|
|
A screen will appear with all the values you need to copy in Mattermost as
|
|
described in the next step. Leave the window open.</p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong>
|
|
GitLab will propose some values for the Mattermost settings. The only one
|
|
required to copy-paste as-is is the <strong>Request URL</strong>, all the others are just
|
|
suggestions.</p>
|
|
</blockquote>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_config_help.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost setup instructions" class="lazy" data-src="img/mattermost_config_help.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
<hr/>
|
|
</li>
|
|
<li>
|
|
<p>Proceed to the next step and create a slash command in Mattermost with the
|
|
above values.</p>
|
|
</li>
|
|
</ol>
|
|
<h3 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#step-3-create-a-new-custom-slash-command-in-mattermost" id="user-content-step-3-create-a-new-custom-slash-command-in-mattermost"></a>Step 3. Create a new custom slash command in Mattermost</h3>
|
|
<p dir="auto">Now that you have enabled custom slash commands in Mattermost and opened
|
|
the Mattermost slash commands service in GitLab, it's time to copy these values
|
|
in a new slash command.</p>
|
|
<ol dir="auto">
|
|
<li>
|
|
<p>Back to Mattermost, under your team page settings, you should see the
|
|
<strong>Integrations</strong> option.</p>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_team_integrations.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost team integrations" class="lazy" data-src="img/mattermost_team_integrations.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
<hr/>
|
|
</li>
|
|
<li>
|
|
<p>Go to the <strong>Slash Commands</strong> integration and add a new one by clicking the
|
|
<strong>Add Slash Command</strong> button.</p>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_add_slash_command.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost add command" class="lazy" data-src="img/mattermost_add_slash_command.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
<hr/>
|
|
</li>
|
|
<li>
|
|
<p>Fill in the options for the custom command as described in
|
|
<a href="#step-2-open-the-mattermost-slash-commands-service-in-gitlab">step 2</a>.</p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong>
|
|
If you plan on connecting multiple projects, pick a slash command trigger
|
|
word that relates to your projects such as <code>/gitlab-project-name</code> or even
|
|
just <code>/project-name</code>. Only use <code>/gitlab</code> if you will only connect a single
|
|
project to your Mattermost team.</p>
|
|
</blockquote>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_slash_command_configuration.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost add command configuration" class="lazy" data-src="img/mattermost_slash_command_configuration.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
</li>
|
|
<li>
|
|
<p>After you setup all the values, copy the token (we will use it below) and
|
|
click <strong>Done</strong>.</p>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_slash_command_token.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost slash command token" class="lazy" data-src="img/mattermost_slash_command_token.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
</li>
|
|
</ol>
|
|
<h3 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#step-4-copy-the-mattermost-token-into-the-mattermost-slash-command-service" id="user-content-step-4-copy-the-mattermost-token-into-the-mattermost-slash-command-service"></a>Step 4. Copy the Mattermost token into the Mattermost slash command service</h3>
|
|
<ol dir="auto">
|
|
<li>
|
|
<p>In GitLab, paste the Mattermost token you copied in the previous step and
|
|
check the <strong>Active</strong> checkbox.</p>
|
|
<p><a class="no-attachment-icon" href="/img/mattermost_gitlab_token.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost copy token to GitLab" class="lazy" data-src="img/mattermost_gitlab_token.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
</li>
|
|
<li>
|
|
<p>Click <strong>Save changes</strong> for the changes to take effect.</p>
|
|
</li>
|
|
</ol>
|
|
<hr/>
|
|
<p dir="auto">You are now set to start using slash commands in Mattermost that talk to the
|
|
GitLab project you configured.</p>
|
|
<h2 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#authorizing-mattermost-to-interact-with-gitlab" id="user-content-authorizing-mattermost-to-interact-with-gitlab"></a>Authorizing Mattermost to interact with GitLab</h2>
|
|
<p dir="auto">The first time a user will interact with the newly created slash commands,
|
|
Mattermost will trigger an authorization process.</p>
|
|
<p dir="auto"><a class="no-attachment-icon" href="/img/mattermost_bot_auth.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost bot authorize" class="lazy" data-src="img/mattermost_bot_auth.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
<p dir="auto">This will connect your Mattermost user with your GitLab user. You can
|
|
see all authorized chat accounts in your profile's page under <strong>Chat</strong>.</p>
|
|
<p dir="auto">When the authorization process is complete, you can start interacting with
|
|
GitLab using the Mattermost commands.</p>
|
|
<h2 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#available-slash-commands" id="user-content-available-slash-commands"></a>Available slash commands</h2>
|
|
<p dir="auto">The available slash commands are:</p>
|
|
<table dir="auto">
|
|
<thead>
|
|
<tr>
|
|
<th>Command</th>
|
|
<th>Description</th>
|
|
<th>Example</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><kbd>/<trigger> issue new <title> <kbd>⇧ Shift</kbd>+<kbd>↵ Enter</kbd> <description></kbd></td>
|
|
<td>Create a new issue in the project that <code><trigger></code> is tied to. <code><description></code> is optional.</td>
|
|
<td><samp>/gitlab issue new We need to change the homepage</samp></td>
|
|
</tr>
|
|
<tr>
|
|
<td><kbd>/<trigger> issue show <issue-number></kbd></td>
|
|
<td>Show the issue with ID <code><issue-number></code> from the project that <code><trigger></code> is tied to.</td>
|
|
<td><samp>/gitlab issue show 42</samp></td>
|
|
</tr>
|
|
<tr>
|
|
<td><kbd>/<trigger> deploy <environment> to <environment></kbd></td>
|
|
<td>Start the CI job that deploys from one environment to another, for example <code>staging</code> to <code>production</code>. CI/CD must be <a href="/ci/yaml/README.md">properly configured</a>.</td>
|
|
<td><samp>/gitlab deploy staging to production</samp></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p dir="auto">To see a list of available commands to interact with GitLab, type the
|
|
trigger word followed by <kbd>help</kbd>. Example: <samp>/gitlab help</samp></p>
|
|
<p dir="auto"><a class="no-attachment-icon" href="/img/mattermost_bot_available_commands.png" rel="noopener noreferrer" target="_blank"><img alt="Mattermost bot available commands" class="lazy" data-src="img/mattermost_bot_available_commands.png" src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="/></a></p>
|
|
<h2 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#permissions" id="user-content-permissions"></a>Permissions</h2>
|
|
<p dir="auto">The permissions to run the <a href="#available-slash-commands">available commands</a> derive from
|
|
the <a href="../../permissions.md#project">permissions you have on the project</a>.</p>
|
|
<h2 dir="auto">
|
|
<a aria-hidden="true" class="anchor" href="#further-reading" id="user-content-further-reading"></a>Further reading</h2>
|
|
<ul dir="auto">
|
|
<li><a href="https://docs.mattermost.com/developer/slash-commands.html" rel="nofollow noreferrer noopener" target="_blank">Mattermost slash commands documentation</a></li>
|
|
<li><a href="https://docs.gitlab.com/omnibus/gitlab-mattermost/" rel="nofollow noreferrer noopener" target="_blank">Omnibus GitLab Mattermost</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|