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 が作業内容を一切失うことなく、以前の Overleaf の認証情報ではなく LDAP のユーザー名（alicejones）とパスワードでログインできるようにすることです。その方法を以下に説明します。

このプロセスでは 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. ユーザーにパスワードのリセットを依頼する

   ユーザーがログインページにアクセスすると、LDAP/SAML のフォームではなく Overleaf のログインフォームが表示されるようになります。

   ユーザーはこれまで Overleaf ネイティブのパスワードを持っていなかった可能性があるため、新たに作成する必要があります。各ユーザーは次の操作を行います。

   • 「Forgot your password?」リンクをクリックします。
   • アカウントに関連付けられたメールアドレス（LDAP/SAML のもの）を入力します。
   • パスワードリセットのメールに記載されたリンクから、新しいパスワードを設定します。

   まだの場合は、メール配信 を有効にする方法のガイドを確認してください。

   完了すると、メールアドレスと新しい Overleaf 固有のパスワードでログインし、すべてのプロジェクトにアクセスできるようになります。