跳转到主要内容

创建管理员用户

Overleaf Toolkit 部署:
Overleaf Toolkit
旧版 docker-compose.yml 部署:
Legacy docker-compose
如果使用所提供邮箱地址的用户尚不存在,该命令会创建该用户,并将其设为管理员。命令输出中包含一个 URL,你可以访问该 URL 为该用户设置密码并首次登录。
如果需要以编程方式操作,你可以使用同一脚本创建普通用户和管理员。创建普通用户时,请省略 —admin 标志。
如果你使用内部账户进行认证,并且需要将现有用户提升为实例管理员或撤销其管理员权限,请执行以下操作:
1

通过管理 UI

  • 以现有管理员身份登录。
  • 点击 Admin -> Manage Users。
  • 搜索该用户并点击其姓名。
  • 点击铅笔图标。
  • 打开或关闭 Admin。
  • 点击 Save 完成操作。

删除用户

一般建议仅在账户不再需要时才删除账户。删除账户会移除该账户,并导致协作者失去对项目的访问权限。如需阻止用户登录并保留其数据,请改为停用该账户。 默认情况下,账户会被软删除。有关从实例中永久删除用户的信息,请参阅环境变量指南中的 ENABLE_CRON_RESOURCE_DELETION。
账户默认会被软删除。有关永久删除的行为,请参阅 ENABLE_CRON_RESOURCE_DELETION。

通过 Admin -> Manage Users

1
  • 以管理员身份登录。
  • 点击 Admin -> Manage Users。
  • 搜索该用户并勾选其姓名旁的复选框。
  • 点击垃圾桶图标。
  • 点击 Delete account 确认。

通过命令行

可以使用以下命令删除用户账户(及其项目)。 Overleaf Toolkit 部署:
Overleaf Toolkit
旧版 docker-compose.yml 部署:
Legacy docker-compose
删除脚本使用了一个硬编码的强制选项,确保即使账户删除邮件发送失败(例如用户的邮箱已停用),删除操作也会继续进行。
可以使用 —skip-email 选项,避免向被删除的用户发送通知邮件。

恢复被软删除的用户

如果用户只是被软删除,你可以恢复其账户以及随账户一起删除的项目。用户自己删除的项目仍保持删除状态。
1
  • 以管理员身份登录。
  • 点击 Admin -> Manage Users。
  • 搜索你要恢复的用户。
  • 点击 Display deleted users。
  • 点击该用户所在行的箭头图标。
  • 点击 Restore 确认。
当 ENABLE_CRON_RESOURCE_DELETION 设置为 true 时,被软删除的账户可以在 90 天内恢复。超过 90 天后,将无法恢复账户。

统计用户数量

你可以通过管理 UI(https://you-instance-url/admin/user#license)获取用户数量。对于以编程方式进行的检查和导出,以下示例可能会有所帮助。 用户总数:
Total number of users
使用 metrics 端点获取用户总数:
Num active users from metrics
活跃用户总数(示例:过去 365 天内活跃的用户):
Total number of active users

更新用户账户信息

账户信息的更新方式取决于是否启用了 SSO。
  • 如果未使用 SSO:
    • 管理员可以通过 Admin -> Manage Users 修改用户账户信息(邮箱、名字、姓氏,以及生成密码重置链接)。
    • 普通用户可以通过 Account -> Account Settings 更新自己的信息(包括更改密码和生成 Git 认证令牌)。
  • 如果使用了 SSO:
    • 可以将 Ayakaleaf Pro 配置为在登录时根据认证系统更新用户的名字和姓氏。
    • 当 OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN 或 OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN 为 true 时,https://your-instance-url/user/settings 上的用户详细信息表单将被禁用,名字/姓氏只能在你的身份管理系统中设置。
更多详情请参阅:

Q&A

回答:没有用于此操作的 HTTP API。请使用上面的 create-user 脚本(不带 --admin)创建账户,或在 Admin → Manage Users 中使用 Create account。设置 EXTERNAL_AUTH 后,该表单中有 Log in with SSO 选项,会创建一个没有本地密码、也没有激活邮件或链接的账户:点击 Create 后对话框即关闭。用户首次通过 LDAP、SAML 或 OIDC 登录时,会获得使用相同邮箱的现有账户,而不是新账户,请参阅账户和密码。
回答:不可以。无论是在 Admin → Manage Users 中还是通过脚本,都无法导出或导入用户账户。账户存储在 MongoDB 中,因此请通过 MongoDB 备份来备份和恢复它们。export-user-projects.mjs 脚本会将用户的项目导出为 zip 文件,而不是导出账户,请参阅导出项目。
回答:create-user 输出的链接有效期为 7 天,并且由于你是从输出中复制该链接,因此无需 SMTP 也能使用。要获取新链接,请使用相同的邮箱再次运行 create-user。对于已有账户,它只会输出一个新链接,但同时也会将该账户的管理员标志设置为与 --admin 一致,因此为管理员运行时请保留 --admin。管理员也可以在不使用邮件的情况下获取重置链接:在 Admin → Manage Users 中点击该用户所在行的锁形图标,再点击 Send reset link,然后从对话框中复制链接。链接有效期为 1 小时,请参阅发送激活或重置链接。或直接设置密码:点击用户姓名,再点击铅笔图标,输入至少 8 个字符的 New password 并点击 Save。仅通过 LDAP、SAML 或 OIDC 登录的账户无法通过任何一种方式获得密码。

最后更新于 4 个月前 本文档页面包含指向外部指南和配置页面的链接。所有链接和查询参数均与原始内容保持一致。
最后修改于 2026年11月13日