{{< details >}}

  • Tier: 基础版, 专业版, 旗舰版
  • Offering: 极狐GitLab 私有化部署, 极狐GitLab 专属

{{< /details >}}

极狐GitLab 可以向极狐GitLab 实例的用户显示两种类型的广播消息：

  • 横幅
  • 通知

可以使用 broadcast messages API 管理广播消息。

横幅

横幅显示在页面顶部，并且可以选择在命令行中作为 Git 远程响应显示。

A broadcast message banner displaying a welcome message.

$ git push
...
remote:
remote: **Welcome to GitLab** :wave:
remote:
...

如果同时有多个横幅处于活动状态，它们按照创建顺序显示在页面顶部。在命令行中，只有最新的横幅会显示。

通知

极狐GitLab 在页面的右下角显示通知。它们可以包含占位符，这些占位符会被当前用户的属性替换：

A broadcast message notification using the name placeholder.

{{name}}, would you like to give us feedback?
<a href="example.com">Take our survey!</a>

如果同时有多个通知处于活动状态，只有最新的会显示。

通知支持以下占位符：

  • {{email}}
  • {{name}}
  • {{user_id}}
  • {{username}}
  • {{instance_id}}

如果用户未登录，与用户相关的值为空。

添加广播消息

要向极狐GitLab 实例上的用户显示消息，添加广播消息。

要添加广播消息：

  1. 在左侧边栏底部，选择 管理员。
  2. 在左侧边栏，选择 消息。
  3. 在右侧，选择 添加新消息。
  4. 添加您的 消息 文本：
    • 消息内容可以包含 Markdown、emoji 和 a 以及 br HTML 标签。
    • br 标签插入一个换行。
    • a HTML 标签接受 class 和 style 属性，具有以下 CSS 属性：
      • color
      • border
      • background
      • padding
      • margin
      • text-decoration
  5. 对于 类型，选择 banner 或 notification。
  6. 选择一个 主题。默认主题是 indigo。
  7. 要启用用户关闭广播消息，选择 可关闭。
  8. 可选。要在命令行中跳过显示广播消息作为 Git 远程响应，清除 Git 远程响应。
  9. 可选。要仅向部分用户显示消息，选择 目标广播消息：
    • 向所有用户显示在所有页面。
    • 向所有用户显示在特定匹配页面。
    • 仅向在群组或项目页面上具有特定角色的用户显示。这一设置会在群组、子群组和项目页面上显示您的消息，但不会在 Git 远程响应中显示。
  10. 如果需要，选择 目标角色 来显示广播消息。
  11. 如果需要，添加一个 目标路径 以仅在与该路径匹配的 URL 上显示广播消息。使用通配符 * 来匹配多个 URL，例如 mygroup/myproject*。
  12. 选择消息开始和结束的日期和时间（UTC）。
  13. 选择 添加广播消息。

当广播消息过期时，它将不再在用户界面中显示，但仍会列在广播消息列表中。

编辑广播消息

如果您必须对广播消息进行更改，可以编辑它。

要编辑广播消息：

  1. 在左侧边栏底部，选择 管理员。
  2. 选择 消息。
  3. 从广播消息列表中，选择消息的编辑按钮。
  4. 在进行必要的更改后，选择 更新广播消息。

通过更改结束日期，可以使过期的消息重新激活。

删除广播消息

如果您不再需要广播消息，可以删除它。您可以在广播消息处于活动状态时删除它。

要删除广播消息：

  1. 在左侧边栏底部，选择 管理员。
  2. 选择 消息。
  3. 从广播消息列表中，选择消息的删除按钮。

当广播消息被删除时，它会从广播消息列表中移除。