{{< details >}}

  • Tier: 基础版，专业版，旗舰版
  • Offering: 私有化部署

{{< /details >}}

在大型组织中，提供有关联系对象或寻求帮助地点的信息非常有用。您可以在极狐GitLab /help 页面上自定义并显示此信息。

添加帮助信息到帮助页面

您可以在极狐GitLab /help 页面顶部添加帮助信息（例如，https://jihulab.com/help）：

  1. 在左侧边栏底部，选择 管理员。
  2. 选择 设置 > 首选项。
  3. 展开 帮助页面。
  4. 在 帮助页面上显示的附加文本 中，输入您希望在 /help 上显示的信息。
  5. 选择 保存更改。

现在您可以在 /help 上看到该消息。

{{< alert type=”note” >}}

默认情况下，/help 对未认证用户可见。然而，如果公共可见性级别受到限制，/help 仅对认证用户可见。

{{< /alert >}}

添加帮助信息到登录页面

{{< history >}}

  • 在极狐GitLab 17.0 中，登录页面上显示的附加文本已被弃用。

{{< /history >}}

要将帮助信息添加到登录页面，请自定义您的登录和注册页面。

隐藏帮助页面上的营销相关条目

极狐GitLab 的营销相关条目偶尔会显示在帮助页面上。要隐藏这些条目：

  1. 在左侧边栏底部，选择 管理员。
  2. 选择 设置 > 首选项。
  3. 展开 帮助页面。
  4. 选择 从帮助页面隐藏营销相关条目 复选框。
  5. 选择 保存更改。

设置自定义支持页面 URL

您可以指定一个自定义 URL，以便用户在以下情况时被重定向：

  • 选择 帮助 > 支持。
  • 在帮助页面上选择 查看我们的网站以获取帮助。
  1. 在左侧边栏底部，选择 管理员。
  2. 选择 设置 > 首选项。
  3. 展开 帮助页面。
  4. 在 支持页面 URL 字段中输入 URL。
  5. 选择 保存更改。

重定向 /help 页面

您可以将所有 /help 链接重定向到符合必要要求的目的地。

  1. 在左侧边栏底部，选择 管理员。
  2. 选择 设置 > 首选项。
  3. 展开 帮助页面。
  4. 在 文档页面 URL 字段中输入 URL。
  5. 选择 保存更改。

如果 文档页面 URL 字段为空，则极狐GitLab 实例显示从极狐GitLab doc 目录中获取的基本版本文档。

目的地要求

重定向 /help 时，极狐GitLab：

  • 使用指定的 URL 作为重定向的基础 URL。
  • 构建完整的 URL 方式为：
    • 添加版本号 (${VERSION})。
    • 添加文档路径。
    • 删除任何 .md 文件扩展名。

例如，如果 URL 设置为 https://gitlab.cn/docs，请求 /help/administration/settings/help_page.md 将重定向到：https://gitlab.cn/docs/${VERSION}/administration/settings/help_page。