Migrasi ke LDAP atau SAML

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

Sekarang, Anda ingin melakukan integrasi dengan sistem LDAP/Active Directory perusahaan Anda. Di sistem tersebut, detail Alice adalah:

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

Tujuan Anda adalah agar Alice dapat login dengan nama pengguna LDAP-nya (alicejones) dan kata sandinya, alih-alih kredensial Overleaf lamanya, tanpa kehilangan pekerjaannya. Berikut cara mewujudkannya.

Proses ini memerlukan pembuatan ulang kontainer sharelatex yang akan menyebabkan downtime. Kami sangat menyarankan Anda membiasakan diri dengan proses ini dengan mencobanya terlebih dahulu di lingkungan pengujian/staging.

1. Minta pengguna Anda memperbarui alamat email mereka

   Akun Overleaf terikat pada alamat email, sehingga langkah pertama adalah menyelaraskan email Overleaf pengguna Anda dengan email LDAP atau SAML mereka.

   Dalam contoh kita, Anda akan meminta Alice untuk login ke akun Overleaf-nya dan mengubah emailnya dari [e-mail] menjadi [e-mail].

   Jangan lupakan diri Anda sendiri! Jika Anda adalah admin, Anda juga perlu memperbarui alamat email Anda sendiri.

   Jika Anda memiliki banyak pengguna, Anda dapat menggunakan skrip Username migration untuk mengubah alamat email utama pengguna secara massal.

2. Aktifkan modul LDAP atau SAML

   Setelah alamat email semua orang diperbarui, saatnya beralih! Anda perlu mengatur variabel lingkungan yang tepat untuk metode autentikasi baru Anda, lalu membuat ulang kontainer sharelatex menggunakan perintah bin/up -d.

   Ini akan mengganti formulir login standar Overleaf dengan formulir LDAP atau SAML yang baru.

   Anda dapat menemukan informasi terkait untuk mengaktifkan LDAP di sini, dan SAML 2.0 di sini.

3. Pengguna kini dapat login melalui LDAP atau SAML

   Saat Alice login berikutnya, ia akan melihat formulir yang baru.

   

   Ia dapat memasukkan nama pengguna LDAP-nya (alicejones) dan kata sandinya, dan karena alamat emailnya kini cocok dengan yang ada di LDAP, ia akan langsung masuk ke akun Overleaf yang sudah ada. Semua proyeknya akan tetap berada di tempat semula.

   Jika Anda mengaktifkan SAML 2.0, pengguna akan melihat tombol yang, ketika diklik, akan mengarahkan mereka ke IdP Anda untuk memasukkan kredensial. Setelah autentikasi berhasil, mereka akan diarahkan kembali ke instans Overleaf Anda dan masuk ke akun mereka.

   

   Lihat halaman Environment Variables untuk informasi tentang cara menyesuaikan tampilan halaman login.

   Dan jika suatu saat Anda perlu melakukan rollback, cukup jadikan konfigurasi LDAP/SAML sebagai komentar dan buat ulang kontainer sharelatex menggunakan perintah bin/up -d. Pengguna kemudian dapat login menggunakan alamat email mereka saat ini dan kata sandi khusus Overleaf.

​

Arah sebaliknya: Beralih dari LDAP/SAML kembali ke autentikasi bawaan

Bagaimana jika Anda sudah menggunakan LDAP atau SAML selama beberapa waktu dan ingin beralih ke sistem login bawaan Overleaf (mungkin Anda sudah tidak menggunakan LDAP lagi)? Tidak masalah! Berikut cara melakukan peralihan tersebut.

1. Periksa bahwa email semua orang sudah benar

   Akun pengguna Anda sudah terhubung dengan alamat email LDAP atau SAML mereka. Email inilah yang akan mereka gunakan untuk login mulai sekarang, jadi pastikan semuanya sudah benar.

2. Nonaktifkan modul LDAP atau SAML

   Cukup hapus atau kosongkan pengaturan konfigurasi LDAP/SAML dan buat ulang kontainer sharelatex menggunakan perintah bin/up -d. Ini akan mengembalikan formulir login email dan kata sandi bawaan Overleaf.

   
3. Minta pengguna mengatur ulang kata sandi mereka

   Saat pengguna Anda mengunjungi halaman login sekarang, mereka akan melihat formulir login Overleaf, bukan formulir LDAP/SAML.

   Karena mereka mungkin belum pernah memiliki kata sandi Overleaf bawaan, mereka perlu membuatnya. Setiap pengguna harus:

   • Mengklik tautan “Forgot your password?”.
   • Memasukkan alamat email yang terkait dengan akunnya (alamat dari LDAP/SAML).
   • Mengikuti tautan di email pengaturan ulang kata sandi untuk menetapkan kata sandi baru.

   Jika belum, lihat panduan kami tentang cara mengaktifkan Pengiriman email.

   Setelah itu, mereka dapat login dengan email dan kata sandi khusus Overleaf yang baru untuk mengakses semua proyek mereka.