迁移到 LDAP 或 SAML

{
  _id：        '123',
  电子邮件：      '[email protected]'
  名： 'Alice',
  姓：  'Jones'
}

现在，您希望与公司 的 LDAP/Active Directory 系统集成。在该系统中，Alice 的详细信息为：

Alice：
  - uid：  'alicejones'
  - mail： '[email protected]'
  - givenName：   'Alice'
  - sn： 'Jones'

您的目标是让 Alice 使用他们的 LDAP 用户名（alicejones）和密码登录，而不是他们以前的 Overleaf 凭证，同时不丢失他们的任何工作。以下是实现该目标的方法。

此过程将需要重新创建 sharelatex 容器，这将导致一段停机时间。我们强烈建议您先在测试/预发布环境中熟悉此过程。

1

请您的用户更新他们的电子邮件地址

Overleaf 帐户与电子邮件地址绑定，因此第一步是使用户的 Overleaf 电子邮件与他们的 LDAP 或 SAML 电子邮件保持同步。

在本示例中，您要请 Alice 登录他们的 Overleaf 帐户并将其电子邮件从 [email protected] 更改为 [email protected].

不要忘了您自己！如果您是管理员，您也需要更新您自己的电子邮件地址。

如果您有大量用户，您可以使用 用户名迁移 脚本批量更改用户的主电子邮件地址。

2

启用 LDAP 或 SAML 模块

一旦所有人的电子邮件地址都更新完毕，就该切换设置了！您需要为新的身份验证方法设置正确的环境变量，然后重新创建 sharelatex 容器，使用 bin/up -d 命令。

这会将标准的 Overleaf 登录表单替换为您新的 LDAP 或 SAML 表单。

您可以找到有关启用 LDAP 的相关信息 这里，以及 SAML 2.0 的信息 这里.

3

用户现在可以通过 LDAP 或 SAML 登录

下次 Alice 前来登录时，他们将看到新的表单。

LDAP/Active Directory 登录页面

他们可以输入他们的 LDAP 用户名（alicejones）和密码，由于他们的电子邮件地址现在与 LDAP 中的匹配，他们将直接登录到现有的 Overleaf 帐户。所有项目都会保持原样。

如果您已启用 SAML 2.0，用户将看到一个按钮，点击后会将他们重定向到您的 IdP 输入凭证。验证成功后，他们会被重定向回您的 Overleaf 实例并登录到他们的帐户。

SAML 登录页面

请参阅 环境变量 页面，了解如何自定义登录页面体验。

如果您需要回滚，只需注释掉 LDAP/SAML 配置并重新创建 sharelatex 容器，使用 bin/up -d 命令。然后用户将能够使用其当前电子邮件地址和 Overleaf 专用密码登录。

另一种情况：从 LDAP/SAML 切换回本地身份验证

如果您已经使用 LDAP 或 SAML 一段时间并想转回 Overleaf 的内置登录系统（例如您已弃用 LDAP），没问题！以下是执行该切换的方法。

1

检查每个人的电子邮件是否正确

您用户的帐户已与他们的 LDAP 或 SAML 电子邮件地址关联。这是他们今后用于登录的电子邮件，请确保一切无误。

2

禁用 LDAP 或 SAML 模块

只需删除或取消设置 LDAP/SAML 配置，然后重新创建 sharelatex 容器，使用 bin/up -d 命令。这样会恢复原生的 Overleaf 电子邮件与密码登录表单。

本地身份验证 登录页面

3

请用户重设他们的密码

当您的用户现在访问登录页面时，他们将看到 Overleaf 登录表单，而不是 LDAP/SAML 的表单。

由于他们可能从未拥有本地的 Overleaf 密码，他们需要创建一个。每位用户应：

• 点击“忘记密码？”链接。

• 输入与其帐户关联的电子邮件地址（来自 LDAP/SAML 的那个）。

• 按照密码重置邮件中的链接设置新密码。

如果您尚未这样做，请查看我们关于启用 电子邮件发送.

的指南。一旦完成，他们就可以使用他们的电子邮件和新的 Overleaf 专用密码登录以访问所有项目。