认证设置

通过用户认证来控制文档的隐私

Pro 方案 包含密码认证。

Enterprise 方案 支持所有认证方式。

启用认证后，用户需先登录才能访问你的文档。

​

认证模式

根据你的访问控制需求，在完整认证和部分认证模式之间进行选择。

完整认证：所有页面均受保护。用户必须先登录才能访问任何内容。

部分认证：部分页面对公众可见，其他页面需要认证。用户可以自由浏览公开内容，仅在访问受保护页面时需要进行认证。

在配置下方任一握手方式时，你需要在控制台设置中选择 完整认证 或 部分认证。

​

配置认证

选择要配置的握手方式。

密码

密码认证仅提供访问控制，不支持内容个性化。

​

前提条件

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

​

实施

1. 创建密码。

   1. 在你的控制台中，前往 Authentication。
   2. 选择 Full Authentication 或 Partial Authentication。
   3. 选择 Password。
   4. 输入一个强密码。
   5. 选择 保存更改。
2. 分发访问权限。

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

​

示例

你的文档托管在 docs.foo.com，你需要基本的访问控制，但不追踪单个用户。你希望阻止公众访问，同时让设置保持简单。

在控制台中创建一个强密码，并将凭据分享给获授权用户。就是这么简单！

​

将页面设为公开

在使用部分认证时，默认所有页面均受保护。你可以在页面或分组级别通过 public 属性将特定页面设置为无需认证即可访问。

​

页面级

要将页面设为公开，请在该页面的 frontmatter 中添加 public: true。

Public page example

---
title: "公开页面"
public: true
---

​

组级

要将某个组内的所有页面设为公开，请在 docs.json 的 navigation 对象中该组名称下添加 "public": true。

Public group example

{
  "navigation": {
    "groups": [
      {
        "group": "公共组",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "私有组",
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}