Ana içeriğe atla
Bu özellik yu-i-i/overleaf-cep tarafından geliştirilmiştir. Burada yapılandırmanız için bazı belgeler sunuyoruz.

Yapılandırma

Overleaf OIDC modülü dahili olarak passport-openidconnect kütüphanesini kullanır. OpenID Connect’i yapılandırırken sorun yaşıyorsanız, beklediği yapılandırma hakkında fikir edinmek için passport-openidconnect README dosyasını okumaya değer. OIDC kimlik doğrulama modülünü etkinleştirmek için EXTERNAL_AUTH ortam değişkeni gereklidir. Bu ortam değişkeni hangi harici kimlik doğrulama yöntemlerinin etkinleştirileceğini belirtir. Bu değişkenin değeri bir listedir. Liste oidc içeriyorsa OIDC kimlik doğrulaması etkinleştirilir. Örneğin: EXTERNAL_AUTH=ldap oidc OIDC kimlik doğrulama yöntemi kullanıldığında, kullanıcı Kimlik Sağlayıcının (IdP) kimlik doğrulama sitesine yönlendirilir. IdP kullanıcının kimliğini başarıyla doğrularsa, Overleaf kullanıcı veritabanında aşağıdaki yapıda bir thirdPartyIdentifiers alanı içeren bir kayıt aranır:
externalUserId, IdP sunucusu tarafından döndürülen profildeki kullanıcı kimliğiyle (OVERLEAF_OIDC_USER_ID_FIELD ortam değişkenine bakın), providerId ise OIDC sağlayıcısının kimliğiyle (OVERLEAF_OIDC_PROVIDER_ID değişkenine bakın) eşleşmelidir. Eşleşen bir kayıt bulunamazsa, veritabanında birincil e-posta adresi IdP kullanıcı profilindeki e-postayla eşleşen bir kullanıcı aranır:
  • Böyle bir kullanıcı bulunursa thirdPartyIdentifiers alanı güncellenir.
  • Eşleşen bir kullanıcı bulunamazsa ve JIT hesap oluşturma devre dışı bırakılmamışsa, IdP profilindeki e-posta adresi ve thirdPartyIdentifiers ile yeni bir kullanıcı oluşturulur.
Her iki durumda da kullanıcının harici OIDC kullanıcısına ‘bağlandığı’ söylenir. Kullanıcının OIDC sağlayıcısıyla bağlantısı /user/settings sayfasından kaldırılabilir.

Değerleri keşif belgesiyle bulma

Her OpenID Sağlayıcısı (OP), <issuer>/.well-known/openid-configuration adresinde bir keşif (discovery) belgesi yayımlar. Değerleri elle yazmak yerine bu belgeden kopyalayın; tek bir yanlış karakter bile oturum açmayı bozmaya yeter.
1

Keşif URL'sini bulun

OP’niz bunu, Overleaf için oluşturduğunuz istemcinin (sağlayıcının) sayfasında gösterir. Authentik’te Applications > Providers sayfasını açın, sağlayıcıyı seçin ve OpenID Configuration URL ile OpenID Configuration Issuer alanlarını bulun:

Authentik: bir sağlayıcının keşif URL'si ve yayıncısı (test örneği)

URL genellikle şöyle görünür:
  • Keycloak: https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration
  • Authentik: https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
2

Değerleri okuyun

URL’yi bir tarayıcıda açın veya Overleaf sunucusunda şunu çalıştırın:
Authentik’in yanıtı şöyle görünür:
Authentik bu URL’leri sağlayıcı sayfasının daha aşağısında da listeler:

Authentik: bir sağlayıcının uç noktaları (test örneği)

3

Bunları variables.env dosyasına kopyalayın

4

Overleaf'in OP'ye erişebildiğini kontrol edin

Overleaf, token ve userinfo uç noktalarını kendi container’ının içinden çağırır; bu nedenle OP’ye yalnızca tarayıcınızdan değil, oradan da erişilebilmelidir:
Çıktı 200 olmalıdır.
issuer değerini sondaki eğik çizgi dahil olmak üzere tam olarak kopyalayın. Overleaf bunu ID token içindeki yayıncıyla karakter karakter karşılaştırır; herhangi bir fark, her OIDC oturum açma işleminin şu hatayla başarısız olmasına neden olur:{"message":{"message":"ID token not issued by expected OpenID provider."}}Authentik’te yayıncı uygulamaya aittir (.../application/o/<application-slug>/). Authorize, token ve userinfo URL’leri tüm uygulamalar tarafından paylaşılsa da yayıncı, Authentik sunucusunun adresi değildir.

Ortam Değişkenleri

Aşağıdaki beş zorunlu değişkenin değerleri, OpenID Sağlayıcınızın (OP) .well-known/openid-configuration uç noktası kullanılarak bulunabilir, yukarıya bakın.
  • OVERLEAF_OIDC_ISSUER (zorunlu)
  • OVERLEAF_OIDC_AUTHORIZATION_URL (zorunlu)
  • OVERLEAF_OIDC_TOKEN_URL (zorunlu)
  • OVERLEAF_OIDC_USER_INFO_URL (zorunlu)
  • OVERLEAF_OIDC_LOGOUT_URL (zorunlu)
Aşağıdaki iki zorunlu değişkenin değerleri OP’nizin yöneticisi tarafından sağlanacaktır
  • OVERLEAF_OIDC_CLIENT_ID (zorunlu)
  • OVERLEAF_OIDC_CLIENT_SECRET (zorunlu)
  • OVERLEAF_OIDC_SCOPE
    • Varsayılan: openid profile email
  • OVERLEAF_OIDC_PROVIDER_ID
    • OP’nin isteğe bağlı kimliği, varsayılan olarak oidc.
  • OVERLEAF_OIDC_PROVIDER_NAME
    • /user/settings sayfasının Linked Accounts bölümünde kullanılan OP adı, varsayılan olarak OIDC Provider.
  • OVERLEAF_OIDC_IDENTITY_SERVICE_NAME
    • Giriş sayfasında kullanılan kimlik hizmetinin görünen adı (varsayılan: Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
  • OVERLEAF_OIDC_PROVIDER_DESCRIPTION
    • Linked Accounts bölümünde kullanılan OP açıklaması (varsayılan: Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
  • OVERLEAF_OIDC_PROVIDER_INFO_LINK
    • OP açıklamasındaki Learn more URL’si; varsayılan: açıklamada Learn more bağlantısı yoktur.
  • OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED
    • Kullanıcının hesabı OP ile bağlı değilse OP’yi /user/settings sayfasında gösterme; varsayılan false.
  • OVERLEAF_OIDC_USER_ID_FIELD
    • Bu özniteliğin değeri Overleaf tarafından harici kullanıcı kimliği olarak kullanılır, varsayılan olarak id. Diğer olası makul değerler email ve username’dir (preferred_username OIDC talebine karşılık gelir).
  • OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS
    • OIDC üzerinden kimlik doğrulayan kullanıcılar için Tam Zamanında (JIT) hesap oluşturmayı kısıtlar. Virgülle ayrılmış bir alan adları listesine ayarlanırsa, yeni bir hesap yalnızca kullanıcının e-posta adresinin alan adı listelenen alan adlarından biriyle eşleşirse oluşturulur. Alan adı eşleşmezse, bir yöneticinin kullanıcı hesabını OIDC kullanıcısının e-posta adresini kullanarak, güçlü ve rastgele bir parolayla ya da tercihen hashedPassword alanı hiç olmadan manuel olarak oluşturması gerekir. Alan adları, alt alan adlarını eşleştirmek için başta bir *. joker karakteri içerebilir.
      • Örnek: name@example.com ve name@math.example.com gibi e-posta adreslerine sahip kullanıcılar için JIT hesap oluşturmaya izin vermek için:
        OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com
      • Örnek: JIT hesap oluşturmayı tamamen devre dışı bırakmak için:
        OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
  • OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN
    • true olarak ayarlanırsa, oturum açıldığında kullanıcının first_name ve last_name alanlarını günceller ve /user/settings sayfasındaki kullanıcı bilgileri formunu devre dışı bırakır.
  • OVERLEAF_OIDC_IS_ADMIN_FIELD ve OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE
    • Her iki ortam değişkeni de ayarlandığında, OP tarafından döndürülen profil OVERLEAF_OIDC_IS_ADMIN_FIELD ile belirtilen özniteliği içeriyorsa ve değeri OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE ile eşleşiyorsa ya da OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE değerini içeren bir diziyse (örneğin groups claim’i) oturum açma işlemi user.isAdmin = true olarak günceller; aksi takdirde user.isAdmin false olarak ayarlanır. OVERLEAF_OIDC_IS_ADMIN_FIELD değeri email ise eşleşme kontrolü için emails[0].value özniteliğinin değeri kullanılır.
OpenID Sağlayıcınız için yönlendirme URL’si https://my-overleaf-instance.com/oidc/login/callback şeklindedir.
variables.env

Adım adım: goauthentik

Bu bölüm, goauthentik ile test edilmiş bir kurulumu adım adım anlatır. https://overleaf.example.com adresini kendi OVERLEAF_SITE_URL değerinizle, https://authentik.example.com adresini ise Authentik’inizin adresiyle değiştirin.
1

Sağlayıcıyı oluşturun

Authentik’te Applications > Providers sayfasını açın, New Provider’a tıklayın, OAuth2/OpenID Provider’ı seçin ve Next’e tıklayın.
  • Client Type: Confidential.
  • Redirect URIs (Protocol settings altında): https://overleaf.example.com/oidc/login/callback adresini Strict eşleşme moduyla ekleyin.
  • Client ID ve Client Secret değerlerini şimdi OVERLEAF_OIDC_CLIENT_ID ve OVERLEAF_OIDC_CLIENT_SECRET değişkenlerine kopyalayın.

Authentik: yeni bir sağlayıcının Client ID ve Client Secret değerleri

Authentik, istemci gizli anahtarını yalnızca sağlayıcıyı oluştururken gösterir. Daha sonra düzenleme formu yalnızca gizli anahtarı yenisiyle değiştiren Modify seçeneğini sunar.
2

Uygulamayı oluşturun

Applications > Applications sayfasını açın, yeni bir uygulama oluşturun, ona bir ad ve bir slug verin, örneğin overleaf, ve sağlayıcıyı seçin. Slug, yayıncının bir parçası olur: https://authentik.example.com/application/o/overleaf/.
3

URL'leri kopyalayın

Beş URL’yi doldurmak için yukarıdaki Değerleri keşif belgesiyle bulma bölümünü izleyin.
4

Yöneticileri eşleyin (isteğe bağlı)

Authentik, kullanıcının gruplarını bir dizi olan groups claim’i olarak gönderir. Authentik grubu Admins üyelerini Overleaf yöneticisi yapmak için:
Yönetici bayrağı her OIDC oturum açma işleminde güncellenir. Yanlış bir alan veya değerle, Launchpad’de oluşturulan yönetici de dahil olmak üzere OIDC üzerinden oturum açan her yönetici yönetici haklarını kaybeder. Eşlemeyi önce ikinci bir yönetici hesabıyla test edin.
variables.env

Soru&Cevap

Cevap: Aşağıdakileri kontrol edin:
  • Sürüm. v6.3.0’dan önce Overleaf, groups gibi özel claim’leri okumuyordu; bu nedenle yalnızca OVERLEAF_OIDC_IS_ADMIN_FIELD=email çalışıyordu. v6.3.0 veya sonraki bir sürüme yükseltin.
  • Claim, UserInfo yanıtında bulunmalıdır. Overleaf claim’i ID token’dan değil, OVERLEAF_OIDC_USER_INFO_URL adresinden okur. OP’niz claim’i yalnızca ID token’a ekliyorsa, onu UserInfo’ya da ekleyin; örneğin bir Keycloak mapper’ında Add to userinfo ile.
  • Değer, büyük/küçük harf dahil tam olarak eşleşmelidir; örneğin Admins.
Yönetici durumu her oturum açmada yeniden kontrol edilir: yönetici panelinde yönetici yapılmış bir kullanıcı, claim eşleşmezse bir sonraki oturum açmada bu yetkisini kaybeder.
Cevap: Hayır. GitHub, kullanıcı girişi için OAuth 2.0’ı destekler ancak OpenID Connect’i desteklemez: Overleaf’in gerektirdiği bir ID token döndürmez; bu nedenle oturum açma ID token not present in token response hatasıyla başarısız olur.Kullanıcıların GitHub hesaplarıyla oturum açmasını sağlamak için, oturum açma kaynağı olarak GitHub’ı kullanan goauthentik veya Keycloak gibi bir kimlik sağlayıcı kullanın ve Overleaf’i OIDC ile bu sağlayıcıya bağlayın.
Cevap: Evet. Kendi kendine yönetilen GitLab dahil GitLab, bir OpenID Connect sağlayıcısıdır. GitLab’da Applications altında (kullanıcı, grup veya Admin alanı ayarlarınızda) aşağıdakilerle bir uygulama oluşturun:
  • Redirect URI: https://my-overleaf-instance.com/oidc/login/callback
  • Scopes: openid, profile ve email
Ardından uç noktaları, Değerleri keşif belgesiyle bulma bölümünde açıklandığı gibi https://gitlab.com/.well-known/openid-configuration adresinden veya kendi GitLab’ınızdaki aynı yoldan okuyun. gitlab.com için issuer, sonunda eğik çizgi olmadan https://gitlab.com değeridir.
Cevap: Overleaf, OP’ye yönlendirmeden önce kullanıcının oturumunda rastgele bir state değeri saklar ve OP geri yönlendirdiğinde bunu kontrol eder. Bu hatalar, callback sırasındaki oturumun oturum açmayı başlatan oturum olmadığı anlamına gelir.Unable to verify authorization request state, tarayıcının callback sırasında oturum çerezini geri göndermediği anlamına gelir. Şunları kontrol edin:
  • Kullanıcılar Overleaf’i OVERLEAF_SITE_URL adresinden açıyor olmalıdır. Callback her zaman OVERLEAF_SITE_URL adresine gider; bu nedenle başka bir adresten başlatılan oturum açma (örneğin OVERLEAF_SITE_URL değeri https://overleaf.example.com iken http://192.168.1.20) oturumunu kaybeder.
  • Overleaf düz HTTP üzerinden sunulduğunda OVERLEAF_SECURE_COOKIE ayarlanmamış olmalıdır. Tarayıcılar HTTP üzerinde güvenli çerezleri düşürür. false dahil herhangi bir değer bunu etkinleştirir; bu nedenle satırı tamamen kaldırın.
Invalid authorization request state, daha yeni bir oturum açmanın saklanan değerin yerini aldığı anlamına gelir; örneğin aynı anda iki sekmeden oturum açıldığında veya oturum açma sırasında tarayıcıda geri gidildiğinde. Diğer sekmeleri kapatın ve oturum açmayı Overleaf giriş sayfasından yeniden başlatın.
Son değiştirilme tarihi 2 Kasım 2026