遷移至 LDAP 或 SAML

{
  _id:        '123',
  email:      '[e-mail]'
  first_name: 'Alice',
  last_name:  'Jones'
}

現在，您想要與公司的 LDAP／Active Directory 系統整合。在該系統中，Alice 的資料如下：

Alice:
  - uid:  'alicejones'
  - mail: '[e-mail]'
  - givenName:   'Alice'
  - sn: 'Jones'

您的目標是讓 Alice 使用其 LDAP 使用者名稱（alicejones）與密碼登入，而非使用舊的 Overleaf 憑證，且不會遺失任何作品。以下說明如何達成。

此流程需要重新建立 sharelatex 容器，這會造成一段停機時間。強烈建議您先在測試／預備環境中實際操作一次，以熟悉此流程。

1. 請使用者更新其電子郵件地址

   Overleaf 帳號與電子郵件地址綁定，因此第一步是讓使用者的 Overleaf 電子郵件與其 LDAP 或 SAML 電子郵件一致。

   在我們的範例中，您需要請 Alice 登入其 Overleaf 帳號，並將電子郵件從 [e-mail] 變更為 [e-mail]。

   別忘了您自己！如果您是管理員，也需要更新您自己的電子郵件地址。

   如果您有大量使用者，可以使用使用者名稱遷移腳本來大量變更使用者的主要電子郵件地址。

2. 啟用 LDAP 或 SAML 模組

   所有人的電子郵件地址都更新後，就可以切換了！您需要為新的驗證方式設定正確的環境變數，然後使用 bin/up -d 指令重新建立 sharelatex 容器。

   這會將標準的 Overleaf 登入表單替換為新的 LDAP 或 SAML 登入表單。

   您可以在這裡找到啟用 LDAP 的相關資訊，SAML 2.0 則請參閱這裡。

3. 使用者現在可以透過 LDAP 或 SAML 登入

   下次 Alice 登入時，就會看到新的表單。

   

   他們可以輸入 LDAP 使用者名稱（alicejones）與密碼，由於其電子郵件地址現在與 LDAP 中的相符，他們會直接登入現有的 Overleaf 帳號。所有專案都會原封不動地保留。

   如果您啟用的是 SAML 2.0，使用者會看到一個按鈕，點選後會將他們重新導向至您的 IdP 輸入憑證。驗證成功後，他們會被重新導向回您的 Overleaf 執行個體並登入其帳號。

   

   有關自訂登入頁面體驗的資訊，請參閱環境變數頁面。

   如果您需要復原，只需將 LDAP／SAML 設定註解掉，並使用 bin/up -d 指令重新建立 sharelatex 容器即可。之後使用者便能使用目前的電子郵件地址與 Overleaf 專用密碼登入。

​

反向操作：從 LDAP／SAML 切換回原生驗證

如果您已使用 LDAP 或 SAML 一段時間，並想改用 Overleaf 內建的登入系統（也許您已淘汰 LDAP），該怎麼辦？沒問題！以下說明如何進行切換。

1. 確認每個人的電子郵件都正確

   您使用者的帳號已經連結到他們的 LDAP 或 SAML 電子郵件地址。從現在起，他們將使用此電子郵件登入，因此只需確認一切無誤即可。

2. 停用 LDAP 或 SAML 模組

   只需移除或取消設定 LDAP／SAML 組態設定，並使用 bin/up -d 指令重新建立 sharelatex 容器。這會恢復 Overleaf 原生的電子郵件與密碼登入表單。

   
3. 請使用者重設密碼

   現在使用者造訪登入頁面時，會看到 Overleaf 登入表單，而非 LDAP／SAML 表單。

   由於他們可能從未擁有 Overleaf 原生密碼，因此需要建立一組。每位使用者應：

   • 點選 “Forgot your password?” 連結。
   • 輸入與其帳號關聯的電子郵件地址（來自 LDAP／SAML 的那個）。
   • 依照密碼重設電子郵件中的連結設定新密碼。

   如果您尚未完成，請參閱我們關於啟用電子郵件傳送的指南。

   完成後，他們就能使用電子郵件與新的 Overleaf 專用密碼登入，存取所有專案。