key已认证访问

为已发布内容设置自定义身份验证

经过身份验证的访问允许你发布内容,同时要求任何想要查看内容的访客进行身份验证。启用后,GitBook 会让你的身份验证提供商来处理谁有权访问内容。

A screenshot showing a login screen for docs behind authenticated access
为你已发布的文档添加登录入口。

使用场景

身份验证访问的常见使用场景包括:

  • 发布敏感的产品文档,这些内容应仅对付费客户、销售线索或合作伙伴开放。

  • 发布内部知识库内容,这些内容应仅对公司员工开放。

工作原理

在设置身份验证访问时,你可以选择两种方式:

  1. 安装我们的身份验证集成之一——我们目前支持 Okta、Azure 和 Auth0。我们 强烈建议 如果你使用的是我们支持的身份验证提供商,请选择此选项。

  2. 创建并托管你自己的服务器来处理身份验证。可以使用许多不同的技术,但由你来编写代码并维护你选择的解决方案。

内置登录和登出 URL

GitBook 为你已发布的网站提供内置的登录和登出 URL:

  • <publishedSiteURL>/~gitbook/auth/login

  • <publishedSiteURL>/~gitbook/auth/logout

可在任何需要登录链接的地方使用登录 URL,例如你网站上的页眉链接。

当访客打开登录 URL 时,GitBook 会将他们重定向到为该站点配置的身份验证后端。该方式适用于集成后端和自定义后端。

GitBook 还会添加一个 location 查询参数,用于匹配访客最初进入的页面。你的后端可以使用该值在登录后将他们送回同一页面。

使用登出 URL 可使访客退出其 GitBook 会话。

前往 启用身份验证访问 开始为你的网站设置受保护访问。

最后更新于

这有帮助吗?