用户管理

创建管理员用户

Overleaf 工具包 部署：

Overleaf 工具包

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin [email protected]"

旧版 docker-compose.yml 部署：

旧版 docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin [email protected]"

该命令将在提供的电子邮件地址对应用户不存在时创建该用户，并将其设为管理员。命令输出包含一个可访问的 URL，您可以在该页面为该用户设置密码并首次登录。

对于编程化的方法，您可以使用相同的脚本创建普通用户以及管理员。对于普通用户请省略 --admin 标志。

如果您使用内部账户进行身份验证并需要将现有用户提升为实例管理员或撤销管理员权限，请执行以下操作：

1

通过管理界面 (Admin UI)

• 以现有管理员身份登录。

• 点击 Admin -> Manage Users。

• 搜索该用户并点击他们的电子邮件地址。

• 向下滚动到 站点管理员 (Site Admin) 部分并点击 (show) 链接。

• 勾选 框：Is Site Admin。

• 点击 保存 以完成操作。

---

删除用户

如我们有关 理解许可使用情况的指南所述，除非账户不再需要，否则通常不建议删除账户。删除账户会移除该账户并导致合作者无法访问项目。目前没有停用账户的方式——账户要么保留并保留其数据，要么被删除。

默认情况下，账户会被软删除。有关永久从实例中移除用户的信息，请参阅 ENABLE_CRON_RESOURCE_DELETION 在 环境变量 指南。

账户默认会被软删除。有关永久删除的行为，请参阅 ENABLE_CRON_RESOURCE_DELETION 。

通过 Admin -> Manage Users

1

• 以管理员身份登录。

• 点击 Admin -> Manage Users。

• 搜索该用户并勾选其电子邮件地址旁的复选框。

• 点击回收桶图标（bin 图标）。

• 点击 删除 以确认。

通过命令行

可使用以下命令删除用户账户（及其项目）。

Overleaf 工具包 部署：

Overleaf 工具包

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs [email protected]"

旧版 docker-compose.yml 部署：

旧版 docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs [email protected]"

删除脚本使用了硬编码的强制选项，确保即使账户删除邮件发送失败（例如用户的邮箱不再可用）也能继续删除。

自 5.5.0 版本起，可使用 --skip-email 选项以避免向被删除用户发送通知邮件。

---

恢复被软删除的用户

如果用户只是被软删除，您可以恢复其账户和项目。

1

• 以管理员身份登录。

• 点击 Admin -> Manage Users。

• 搜索您想要恢复的用户。

• 点击 显示已删除用户（Display deleted users） 按钮。

• 点击已删除用户的电子邮件地址。

• 点击 恢复此账户（Recover This Account）。

• 点击 恢复（Recover） 以确认。

当 ENABLE_CRON_RESOURCE_DELETION 设置为 true 时，被软删除的账户可以在 90 天窗口内恢复。90 天后，账户无法恢复。

---

统计用户数量

您可以通过管理界面在 https://you-instance-url/admin/user#license 获取用户计数。对于编程化检查和导出，以下示例可能有帮助。

用户总数：

用户总数

echo 'db.users.countDocuments()' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 16

通过 metrics 端点的用户总数：

来自 metrics 的活跃用户数量

docker exec sharelatex curl http://127.0.0.1:3000/metrics | grep num_active_users
# # HELP num_active_users num_active_users
# # TYPE num_active_users gauge
# num_active_users{app="web-api",host="b3ae4ff549d8"} 16

活跃用户总数（示例：过去 365 天内活跃的用户）：

活跃用户总数

echo 'db.users.countDocuments({ lastActive: { $gte: new Date(new Date().getTime() - (365 * 24 * 60 * 60 * 1000)) } })' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 10

---

更新用户账户信息

账户更新的执行方式取决于是否启用了 SSO。

• 如果不使用 SSO：

  • 管理员可以通过 Admin -> Manage Users 修改用户账户信息（电子邮件、名字、姓氏，并生成密码重置链接）。

  • 普通用户可以通过 Account -> Account Settings 更新自己的详细信息（包括更改密码和生成 Git 认证令牌）。

• 如果使用 SSO：

  • Server Pro 可配置为在登录期间根据身份验证系统更新用户的名字和姓氏。

  • 当 OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN 或 OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN 为 true 时，https://your-instance-url/user/settings 上的用户详情表单将被禁用，名字/姓氏只能在您的身份管理系统中设置。

更多详情请参见：

• SAML 2.0 配置： https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0

• LDAP 配置： https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap

---

最后更新：4 个月前

此文档页面包含指向外部指南和配置页面的链接。所有链接和查询参数均与原始内容保持一致。