• 如何工作
• 配置服务台
  • 提高项目的安全性
  • 创建自定义邮件模版
    • 电子邮件页眉和页脚
    • 感谢电子邮件
    • 新笔记邮件
    • 为服务台议题使用自定义模板
  • 支持机器人用户
    • 更改支持机器人的显示名称
  • 使用自定义电子邮件地址
    • 配置自定义邮箱
      • Microsoft Graph
    • 配置自定义邮箱后缀
• 使用服务台
  • 查看服务台电子邮件地址
  • 作为最终用户（议题创建者）
  • 作为议题回复者
    • 查看服务台议题
  • 电子邮件内容和格式
    • HTML 电子邮件中的特殊 HTML 格式
    • 附加到评论的文件
• 隐私注意事项
  • 移动服务台议题
• 服务台故障排除
  • 发送至服务台的电子邮件不会创建议题

服务台

在 13.2 版本中移至标准版

服务台是一个服务模块，它可以在不借助任何外部工具的情况下，使您的团队通过电子邮件与任何外部方联系。

借助服务台，您可以为客户提供高效的电子邮件支持。 他们可以通过电子邮件向您发送错误报告、功能请求或一般反馈。它们最终都会作为新的议题出现在您的项目中。反过来，您的团队可以直接从项目中做出响应。

由于服务台内置于极狐GitLab 中，因此消除了多种工具和外部集成的复杂性和低效性。这大大缩短了从反馈到软件更新的周期时间。

如何工作

服务台使人们可以在您的极狐GitLab 实例中创建议题，而无需提供他们自己的账号信息。

它为最终用户在项目中创建问题提供了一个唯一的电子邮件地址。后续内容可以通过极狐GitLab 界面或通过电子邮件发送。最终用户只能通过电子邮件看到。

例如，假设您为 iOS 或 Android 开发游戏。代码库托管在您的极狐GitLab 实例中，构建和部署使用极狐GitLab CI/CD。

服务台是这样工作的：

1. 您为付费客户提供特定项目的电子邮件地址，用户可以直接从应用程序向您发送电子邮件。
2. 他们发送的每封电子邮件都会在相应的项目中产生一个议题。
3. 您的团队成员导航到服务台问题跟踪器，在那里他们可以查看新的技术支持请求并在相关议题中做出响应。
4. 您的团队与客户来回多次沟通以了解请求。
5. 您的团队开始致力于代码编写以解决客户的问题。
6. 当您的团队完成功能实现时，合并请求随即被处理并自动关闭议题。
7. 客户的请求通过电子邮件处理，无需访问您的极狐GitLab 实例。
8. 您的团队不必奔波来回于您的客户，这节省了大量时间。

配置服务台

要开始为项目使用服务台，您必须先将其打开。默认情况下，服务台处于关闭状态。

先决条件：

• 您必须至少具有项目的维护者角色。
• 在私有化部署版上，您必须为极狐GitLab 实例设置传入电子邮件。您应该使用电子邮件子寻址，但您也可以使用万能邮箱。为此，您必须具有管理员访问权限。

在您的项目中启用服务台：

1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
2. 在左侧边栏中，选择 设置 > 通用。
3. 展开 服务台。
4. 打开 启用服务台 开关。
5. 可选。填写字段。
   • 添加后缀到您的服务台电子邮件地址。
   • 如果 附加到所有服务台生成议题的模板 下面的列表是空的，请在您的存储库中创建一个描述模板。
6. 选择 保存更改。

现在已为此项目启用服务台。 如果有人向 用于服务台的电子邮件地址 下的可用地址发送电子邮件，极狐GitLab 使用电子邮件的内容创建了一个机密议题。

提高项目的安全性

要提高服务台项目的安全性，您应该：

• 在您的电子邮件系统为服务台邮件地址配置一个别名，以后方便更改。
• 在您的实例中开启 Akismet 添加垃圾邮件检查。那些未被阻止的垃圾电子邮件可能会导致创建许多垃圾邮件议题。

创建自定义邮件模版

• 在 12.7 版本的专业版中引入。
• 在 13.2 版本中该功能转移到标准版。

在以下情况下会向作者发送电子邮件：

• 用户使用服务台提交新议题。
• 在服务台议题上创建了一个新注释。

您可以使用模版来定制化邮件内容。

电子邮件页眉和页脚

引入于 15.9 版本。

实例管理员可以为极狐GitLab 实例添加一个小的页眉或页脚，并使它们在电子邮件模板中可见。有关详细信息，请参阅系统页眉和页脚消息。

感谢电子邮件

%{ISSUE_DESCRIPTION} 引入于 16.0 版本。

当用户通过服务台提交议题时，极狐GitLab 会发送 感谢电子邮件。

要创建自定义电子邮件模板，请在仓库的 .gitlab/service_desk_templates/ 目录中创建一个名为 thank_you.md 的文件。

您可以在电子邮件中使用下面这些占位符：

• %{ISSUE_ID}：议题 IID
• %{ISSUE_PATH}：附加议题 IID 的项目路径
• %{ISSUE_DESCRIPTION}：基于原始邮件的议题秒述
• %{UNSUBSCRIBE_URL}：退订 URL
• %{SYSTEM_HEADER}：系统页眉消息
• %{SYSTEM_FOOTER}：系统页脚消息
• %{ADDITIONAL_TEXT}：自定义附加文本

因为服务台议题是机密的（只有项目成员可以看到它们），回复电子邮件不包含议题链接。

新笔记邮件

%{ISSUE_DESCRIPTION} 引入于 16.0 版本。

当用户提交的议题收到新评论时，极狐GitLab 会发送一封新的注释电子邮件。

要创建自定义电子邮件模板，请在仓库的 .gitlab/service_desk_templates/ 目录中创建一个名为 new_note.md 的文件。

您可以在电子邮件中使用下面这些占位符：

• %{ISSUE_ID}：议题 ID
• %{ISSUE_PATH}：附加议题 ID 的项目路径
• %{ISSUE_DESCRIPTION}：生成电子邮件时的议题描述。如果用户编辑了描述，则可能包含不打算传递给外部参与者的敏感信息。仅当您从未修改描述或您的团队知道模板设计时才使用此占位符。
• %{NOTE_TEXT}：笔记内容
• %{UNSUBSCRIBE_URL}：退订 URL
• %{SYSTEM_HEADER}：系统页眉消息
• %{SYSTEM_FOOTER}：系统页脚消息
• %{ADDITIONAL_TEXT}：自定义附加文本

为服务台议题使用自定义模板

您可以为每个项目选择一个议题描述模板，他们会附加到每个新的服务台议题的描述中。

您可以设置不同级别的描述模板：

• 整个实例。
• 特定的群组或子组。
• 特定的项目。

模板是继承的。例如，在项目中，您还可以访问为实例或项目的父组设置的模板。

先决条件：

• 您必须创建描述模板。

要将自定义描述模板与服务台一起使用：

1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
2. 在左侧边栏中，选择 设置 > 通用。
3. 展开 服务台。
4. 从 附加到所有服务台生成议题的模板 下拉列表中，搜索或选择您的模板。

支持机器人用户

在后台，由创建议题的特殊支持机器人用户为服务台工作。 该用户不是计费用户，因此不计入许可证限制计数。

更改支持机器人的显示名称

您可以更改支持机器人用户的显示名称。从服务台发送的电子邮件在 From 标头中使用此名称。默认显示名称为 GitLab Support Bot。

要编辑自定义电子邮件显示名称：

1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
2. 在左侧边栏中，选择 设置 > 通用。
3. 展开 服务台。
4. 在 电子邮件显示名称 下方，输入一个新名称。
5. 选择 保存更改。

使用自定义电子邮件地址

您可以将自定义电子邮件地址用于服务台。

为此，您必须配置一个自定义邮箱。您还可以配置自定义后缀。

配置自定义邮箱

使用 service_desk_email 配置，您可以自定义服务台使用的邮箱，系统允许您通过在项目设置中配置自定义后缀来为服务台提供单独的电子邮件地址。

先决条件：

• address 必须包含 ‘user’ 中 +%{key} 占位符 @ 之前的地址部分，用于标示应在哪个项目中创建议题。
• service_desk_email 和 incoming_email 配置必须始终使用单独的邮箱以确保正确处理服务台电子邮件。

要使用 IMAP 为服务台配置自定义邮箱，请将以下片段完整添加到您的配置文件中：

Omnibus

gitlab_rails['service_desk_email_enabled'] = true
gitlab_rails['service_desk_email_address'] = "project_contact+%{key}@gmail.com"
gitlab_rails['service_desk_email_email'] = "project_contact@gmail.com"
gitlab_rails['service_desk_email_password'] = "[REDACTED]"
gitlab_rails['service_desk_email_mailbox_name'] = "inbox"
gitlab_rails['service_desk_email_idle_timeout'] = 60
gitlab_rails['service_desk_email_log_file'] = "/var/log/gitlab/mailroom/mail_room_json.log"
gitlab_rails['service_desk_email_host'] = "imap.gmail.com"
gitlab_rails['service_desk_email_port'] = 993
gitlab_rails['service_desk_email_ssl'] = true
gitlab_rails['service_desk_email_start_tls'] = false

源安装

service_desk_email:
  enabled: true
  address: "project_contact+%{key}@example.com"
  user: "project_contact@example.com"
  password: "[REDACTED]"
  host: "imap.gmail.com"
  delivery_method: webhook
  secret_file: .gitlab-mailroom-secret
  port: 993
  ssl: true
  start_tls: false
  log_path: "log/mailroom.log"
  mailbox: "inbox"
  idle_timeout: 60
  expunge_deleted: true

Microsoft Graph

在 13.11 版本中引入。

服务台可以配置为使用 Microsoft Graph API 而不是 IMAP 读取 Microsoft Exchange Online 邮箱。

• 以 Ominbus 方式安装配置示例：

  gitlab_rails['service_desk_email_enabled'] = true
  gitlab_rails['service_desk_email_address'] = "project_contact+%{key}@example.onmicrosoft.com"
  gitlab_rails['service_desk_email_email'] = "project_contact@example.onmicrosoft.com"
  gitlab_rails['service_desk_email_mailbox_name'] = "inbox"
  gitlab_rails['service_desk_email_log_file'] = "/var/log/gitlab/mailroom/mail_room_json.log"
  gitlab_rails['service_desk_email_inbox_method'] = 'microsoft_graph'
  gitlab_rails['service_desk_email_inbox_options'] = {
   'tenant_id': '<YOUR-TENANT-ID>',
   'client_id': '<YOUR-CLIENT-ID>',
   'client_secret': '<YOUR-CLIENT-SECRET>',
   'poll_interval': 60  # Optional
  }
  

以源代码方式安装暂时不支持 Microsoft Graph API 配置。

配置自定义邮箱后缀

配置自定义邮箱后，您可以在项目的服务台设置中设置自定义后缀。它只能包含小写字母 (a-z)、数字 (0-9) 或下划线 (_)。

配置后，自定义后缀会创建一个新的服务台电子邮件地址，其中包括 service_desk_email_address 设置和格式：<project_full_path>-<custom_suffix>

先决条件：

• 您必须配置了一个自定义邮箱。

1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
2. 在左侧边栏中，选择 设置 > 通用。
3. 展开 服务台。
4. 在 电子邮件地址后缀 下方，输入要使用的后缀。
5. 选择 保存更改。

比如 mygroup/myproject 项目服务台设置的配置如下：

• 电子邮件后缀为 support.
• 服务台邮箱地址配置为contact+%{key}@example.com.

这个项目的服务台邮箱地址就是：contact+mygroup-myproject-support@example.com。同时 incoming email 地址也是可以正常工作的。

如果不配置自定义后缀，将使用默认的项目标识来标识项目。您可以在项目设置中看到该电子邮件地址。

使用服务台

您可以使用服务台创建议题或回复一个议题。

在这些议题中，您还可以看到支持机器人用户。

查看服务台电子邮件地址

要检查您的项目的服务台电子邮件地址：

1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
2. 在左侧边栏中，选择 议题 > 服务台。

电子邮件地址位于议题列表的顶部。

作为最终用户（议题创建者）

支持额外的 email headers 引入于 14.6 版本。 在早期版本中，服务台电子邮件地址必须位于 “To” 字段中。

要创建服务台议题，最终用户不需要了解有关极狐GitLab 实例的任何信息。他们只是向他们提供的地址发送一封电子邮件，然后收到一封确认收到的电子邮件：

这也为最终用户提供了取消订阅的选项。

如果他们不选择退订，则添加到该问题的任何新评论都将作为电子邮件发送：

议题中会显示所有通过邮件做出的回复。

作为议题回复者

对于议题的回复者来说，一切都和其它极狐GitLab 议题一样。回复者可以在其中查看通过客户支持请求创建的问题，并过滤它们或与之交互。

来自最终用户的消息会显示为来自特殊的机器人用户。您可以像在极狐GitLab 中一样阅读和编写评论：

查看服务台议题

先决条件：

• 您必须至少具有该项目的报告者角色。

查看服务台问题：

1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
2. 在左侧边栏中，选择 议题 > 服务台。

电子邮件内容和格式

HTML 电子邮件中的特殊 HTML 格式

• 引入于 15.9 版本，功能标志为 service_desk_html_to_text_email_handler。默认禁用。
• 一般可用于 15.11 版本，删除功能标志 service_desk_html_to_text_email_handler。

HTML 电子邮件显示 HTML 格式，例如：

• 表格
• 引用
• 图片
• 可折叠部分

附加到评论的文件

• 引入于 15.8 版本，功能标志为 service_desk_new_note_email_native_attachments，默认禁用。
• 在 SaaS 和私有化部署版上启用于 15.10 版本。

如果评论包含任何附件并且它们的总大小小于或等于 10 MB，这些附件将作为电子邮件的一部分发送。在其他情况下，电子邮件包含指向附件的链接。

在 15.9 及更早版本中，上传到评论的内容将作为电子邮件中的链接发送。

隐私注意事项

服务台议题是私密的，所以只对项目成员可见。但项目所有者可以将议题公开。 当服务台议题公开时，至少具有项目报告者角色的登录用户可以看到议题创建者和参与者的电子邮件地址。

您项目中的任何人都可以使用服务台电子邮件地址在此项目中创建议题，无论他们在项目中的角色为何。

唯一的内部电子邮件地址对至少为报告者角色的项目成员可见。 外部用户（议题创建者）无法看到信息说明中显示的内部电子邮件地址。

移动服务台议题

变更于 15.7 版本：移动服务台议题后，客户会继续收到通知。

您可以像在极狐GitLab 中移动普通议题一样移动服务台议题。

如果将服务台议题移至启用了服务台的不同项目，创建该议题的客户将继续收到电子邮件通知。 因为移动的议题会首先被关闭，然后再复制，所以用户会被认为是这两个议题的参与者。他们继续收到旧议题和新议题的任何通知。

服务台故障排除

发送至服务台的电子邮件不会创建议题

您的电子邮件会被忽略，可能是因为它们包含极狐GitLab 忽略的电子邮件 headers 之一。