Konfigurasi
Secara internal, modul OIDC Overleaf menggunakan pustaka passport-openidconnect. Jika Anda mengalami masalah saat mengonfigurasi OpenID Connect, ada baiknya membaca README untukpassport-openidconnect untuk memahami konfigurasi yang diharapkannya.
Variabel lingkungan EXTERNAL_AUTH diperlukan untuk mengaktifkan modul autentikasi OIDC. Variabel lingkungan ini menentukan metode autentikasi eksternal mana yang diaktifkan. Nilai variabel ini berupa daftar. Jika daftar tersebut menyertakan oidc, autentikasi OIDC akan diaktifkan.
Contoh: EXTERNAL_AUTH=ldap oidc
Saat menggunakan metode autentikasi OIDC, pengguna diarahkan ke situs autentikasi Identity Provider (IdP). Jika IdP berhasil mengautentikasi pengguna, database pengguna Overleaf diperiksa untuk mencari catatan yang berisi kolom thirdPartyIdentifiers dengan struktur sebagai berikut:
externalUserId harus cocok dengan ID pengguna dalam profil yang dikembalikan oleh server IdP (lihat variabel lingkungan OVERLEAF_OIDC_USER_ID_FIELD), dan providerId harus cocok dengan ID penyedia OIDC (lihat OVERLEAF_OIDC_PROVIDER_ID).
Jika tidak ditemukan catatan yang cocok, database akan dicari untuk menemukan pengguna dengan alamat email utama yang cocok dengan email di profil pengguna IdP:
- Jika pengguna tersebut ditemukan, kolom
thirdPartyIdentifiersakan diperbarui. - Jika tidak ditemukan pengguna yang cocok dan pembuatan akun JIT tidak dinonaktifkan, pengguna baru akan dibuat dengan alamat email dan
thirdPartyIdentifiersdari profil IdP.
/user/settings.
Menemukan nilai dengan dokumen discovery
Setiap OpenID Provider (OP) menerbitkan dokumen discovery di<issuer>/.well-known/openid-configuration. Salin nilai-nilainya dari dokumen tersebut alih-alih mengetiknya secara manual; satu karakter yang salah saja sudah cukup untuk menggagalkan login.
Temukan URL discovery

Authentik: URL discovery dan issuer sebuah provider (instans uji)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Baca nilainya

Authentik: endpoint sebuah provider (instans uji)
Salin ke variables.env
Pastikan Overleaf dapat menjangkau OP
200.Variabel Lingkungan
Nilai dari lima variabel wajib berikut dapat ditemukan menggunakan endpoint.well-known/openid-configuration dari OpenID Provider (OP) Anda, lihat di atas.
OVERLEAF_OIDC_ISSUER(wajib)OVERLEAF_OIDC_AUTHORIZATION_URL(wajib)OVERLEAF_OIDC_TOKEN_URL(wajib)OVERLEAF_OIDC_USER_INFO_URL(wajib)OVERLEAF_OIDC_LOGOUT_URL(wajib)
OVERLEAF_OIDC_CLIENT_ID(wajib)OVERLEAF_OIDC_CLIENT_SECRET(wajib)OVERLEAF_OIDC_SCOPE- Default:
openid profile email
- Default:
OVERLEAF_OIDC_PROVIDER_ID- ID bebas untuk OP, default-nya
oidc.
- ID bebas untuk OP, default-nya
OVERLEAF_OIDC_PROVIDER_NAME- Nama OP, digunakan di bagian
Linked Accountspada halaman/user/settings, default-nyaOIDC Provider.
- Nama OP, digunakan di bagian
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Nama tampilan untuk layanan identitas, digunakan di halaman login (default:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Nama tampilan untuk layanan identitas, digunakan di halaman login (default:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Deskripsi OP, digunakan di bagian
Linked Accounts(default:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Deskripsi OP, digunakan di bagian
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL
Learn moredalam deskripsi OP; default: tidak ada tautanLearn moredalam deskripsi.
- URL
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Jangan tampilkan OP di halaman
/user/settingsjika akun pengguna tidak tertaut dengan OP; defaultfalse.
- Jangan tampilkan OP di halaman
OVERLEAF_OIDC_USER_ID_FIELD- Nilai atribut ini akan digunakan oleh Overleaf sebagai ID pengguna eksternal, default-nya
id. Nilai lain yang masuk akal adalahemaildanusername(sesuai dengan klaim OIDCpreferred_username).
- Nilai atribut ini akan digunakan oleh Overleaf sebagai ID pengguna eksternal, default-nya
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Membatasi pembuatan akun Just-in-Time (JIT) untuk pengguna yang melakukan autentikasi melalui OIDC. Jika diatur ke daftar nama domain yang dipisahkan koma, akun baru hanya akan dibuat jika domain alamat email pengguna cocok dengan salah satu domain dalam daftar. Jika domain tidak cocok, admin harus membuat akun pengguna secara manual menggunakan alamat email pengguna OIDC, dengan kata sandi acak yang kuat atau, sebaiknya, tanpa kolom
hashedPasswordsama sekali. Nama domain dapat menyertakan wildcard*.di awal untuk mencocokkan subdomain.- Contoh: Untuk mengizinkan pembuatan akun JIT bagi pengguna dengan alamat email seperti
name@example.comdanname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Contoh: Untuk menonaktifkan pembuatan akun JIT sepenuhnya:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Contoh: Untuk mengizinkan pembuatan akun JIT bagi pengguna dengan alamat email seperti
- Membatasi pembuatan akun Just-in-Time (JIT) untuk pengguna yang melakukan autentikasi melalui OIDC. Jika diatur ke daftar nama domain yang dipisahkan koma, akun baru hanya akan dibuat jika domain alamat email pengguna cocok dengan salah satu domain dalam daftar. Jika domain tidak cocok, admin harus membuat akun pengguna secara manual menggunakan alamat email pengguna OIDC, dengan kata sandi acak yang kuat atau, sebaiknya, tanpa kolom
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Jika diatur ke
true, kolomfirst_namedanlast_namepengguna akan diperbarui saat login, dan formulir detail pengguna di halaman/user/settingsakan dinonaktifkan.
- Jika diatur ke
OVERLEAF_OIDC_IS_ADMIN_FIELDdanOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Ketika kedua variabel lingkungan diatur, proses login akan memperbarui
user.isAdmin = truejika profil yang dikembalikan oleh OP berisi atribut yang ditentukan olehOVERLEAF_OIDC_IS_ADMIN_FIELDdan nilainya cocok denganOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEatau berupa array yang berisiOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(misalnya klaimgroups); jika tidak,user.isAdmindiatur kefalse. JikaOVERLEAF_OIDC_IS_ADMIN_FIELDadalahemail, nilai atributemails[0].valuedigunakan untuk pemeriksaan kecocokan.
- Ketika kedua variabel lingkungan diatur, proses login akan memperbarui
https://my-overleaf-instance.com/oidc/login/callback.
Contoh file variables.env
Contoh file variables.env
Langkah demi langkah: goauthentik
Panduan ini menjelaskan penyiapan yang telah diuji dengan goauthentik. Gantihttps://overleaf.example.com dengan OVERLEAF_SITE_URL Anda dan https://authentik.example.com dengan alamat Authentik Anda.
Buat provider
- Client Type:
Confidential. - Redirect URIs (di bawah Protocol settings): tambahkan
https://overleaf.example.com/oidc/login/callbackdengan mode pencocokanStrict. - Salin Client ID dan Client Secret sekarang ke
OVERLEAF_OIDC_CLIENT_IDdanOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID dan Client Secret provider baru
Buat aplikasi
overleaf, lalu pilih provider-nya. Slug tersebut menjadi bagian dari issuer: https://authentik.example.com/application/o/overleaf/.Salin URL
Petakan admin (opsional)
groups, berupa array. Untuk menjadikan anggota grup Authentik Admins sebagai admin Overleaf:variables.env yang telah diuji untuk goauthentik
variables.env yang telah diuji untuk goauthentik
Tanya Jawab
Klaim admin sudah diatur, tetapi pengguna tidak menjadi administrator
Klaim admin sudah diatur, tetapi pengguna tidak menjadi administrator
- Versi. Sebelum v6.3.0, Overleaf tidak membaca klaim kustom seperti
groups, sehingga hanyaOVERLEAF_OIDC_IS_ADMIN_FIELD=emailyang berfungsi. Tingkatkan ke v6.3.0 atau yang lebih baru. - Klaim harus ada di respons UserInfo. Overleaf membaca klaim dari
OVERLEAF_OIDC_USER_INFO_URL, bukan dari ID token. Jika OP Anda hanya menambahkan klaim ke ID token, tambahkan juga ke UserInfo, misalnya dengan Add to userinfo pada mapper Keycloak. - Nilainya harus sama persis, termasuk huruf besar-kecilnya, misalnya
Admins.
Bisakah saya menggunakan GitHub sebagai penyedia OIDC?
Bisakah saya menggunakan GitHub sebagai penyedia OIDC?
ID token not present in token response.Agar pengguna dapat login dengan akun GitHub mereka, gunakan penyedia identitas seperti goauthentik atau Keycloak, dengan GitHub sebagai sumber loginnya, lalu hubungkan Overleaf ke penyedia tersebut dengan OIDC.Bisakah saya menggunakan GitLab sebagai penyedia OIDC?
Bisakah saya menggunakan GitLab sebagai penyedia OIDC?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profiledanemail
https://gitlab.com/.well-known/openid-configuration, atau dari path yang sama di GitLab Anda, seperti yang dijelaskan di Menemukan nilai dengan dokumen discovery. Untuk gitlab.com, issuer-nya adalah https://gitlab.com, tanpa garis miring di akhir.
