跳转到主要内容
专业版包含密码认证。企业版包含所有认证方式。
启用身份认证后,用户需先登录才能访问你的文档。

认证模式

根据你的访问控制需求,在完整认证和部分认证两种模式中进行选择。 完整认证:所有页面均受保护。用户必须先登录才能访问任何内容。 部分认证:部分页面对公众可见,其他页面需要认证。用户可自由浏览公开内容,访问受保护页面时再进行认证。 在配置下方任一握手方式时,你需要在控制台设置中选择 完整认证部分认证

配置认证

选择要配置的握手方式。
  • 密码
  • Mintlify 控制台
  • OAuth 2.0
  • JWT
密码认证仅用于访问控制,支持内容个性化。

前提条件

  • 你的安全策略允许在用户之间共享同一密码。

实施

1

创建密码

  1. 在仪表盘中前往 Authentication
  2. 选择 Full AuthenticationPartial Authentication
  3. 选择 Password
  4. 输入一个安全的密码。
  5. 选择 Save changes
2

分发访问权限

将密码和文档 URL 以安全方式分享给获授权的用户。

示例

你的文档托管在 docs.foo.com,你需要基础访问控制,但不追踪单个用户。你想阻止公开访问,同时保持设置简单。在仪表盘中创建强密码,并将凭据分享给获授权的用户。就是这么简单!

将页面设为公开

在使用部分认证时,所有页面默认受保护。你可以在页面或分组级别通过 public 属性,使特定页面在无需认证的情况下可见。

页面级

要将页面设为公开,请在该页面的 frontmatter 中添加 public: true
公共页面示例
---
title: "公开页面"
public: true
---

组级别

要将某个分组中的所有页面设为公开,请在 docs.jsonnavigation 对象中该分组名称下添加 "public": true
公共分组示例
{
  "navigation": {
    "groups": [
      {
        "group": "公共分组",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "私有分组"
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}