使用者管理

​

建立管理員使用者

Overleaf Toolkit 部署：

Overleaf Toolkit

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

舊版 docker-compose.yml 部署：

Legacy docker-compose

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

如果使用者尚不存在，此指令會以所提供的電子郵件地址建立使用者，並將其設為管理員。指令輸出中會包含一個 URL，您可以前往該網址為此使用者設定密碼並首次登入。

若要以程式化方式處理，您也可以使用同一個指令碼建立一般使用者與管理員。建立一般使用者時，請省略 —admin 旗標。

如果您使用內部帳號進行驗證，並需要將現有使用者提升為執行個體管理員或撤銷其管理員權限，請執行以下步驟：

1. 透過管理介面

   • 以現有管理員身分登入。
   • 點選 Admin -> Manage Users。
   • 搜尋該使用者並點選其電子郵件地址。
   • 向下捲動至 Site Admin 區段，並點選 (show) 連結。
   • 勾選 Is Site Admin 方塊。
   • 點選 Save 完成設定。

---

​

刪除使用者

一般而言，除非帳號已不再需要，否則建議不要刪除帳號。刪除帳號會移除該帳號，並導致協作者失去專案的存取權。目前沒有停用帳號的方法——帳號要嘛保留其資料而存在，要嘛被刪除。

預設情況下，帳號會被軟刪除。關於從執行個體中永久移除使用者的資訊，請參閱環境變數指南中的 ENABLE_CRON_RESOURCE_DELETION。

帳號預設會被軟刪除。永久刪除的行為請參閱 ENABLE_CRON_RESOURCE_DELETION。

​

透過 Admin -> Manage Users

1. • 以管理員身分登入。
   • 點選 Admin -> Manage Users。
   • 搜尋該使用者，並勾選其電子郵件地址旁的方塊。
   • 點選垃圾桶圖示。
   • 點選 Delete 確認。

​

透過命令列

可以使用以下指令刪除使用者帳號（及其專案）。

Overleaf Toolkit 部署：

Overleaf Toolkit

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

舊版 docker-compose.yml 部署：

Legacy docker-compose

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

刪除指令碼使用了寫死的強制選項，可確保即使帳號刪除通知信寄送失敗（例如使用者的電子郵件已停用），刪除仍會繼續進行。

從 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 取得使用者數量。若要以程式化方式檢查與匯出，以下範例可能會有所幫助。

使用者總數：

Total number of users

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

使用 metrics 端點取得使用者總數：

Num active users from 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 天內活躍的使用者）：

Total number of active users

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 個月前

本說明文件頁面包含外部指南與設定頁面的連結。所有連結與查詢參數皆保留原始內容。