Cấu hình
Về mặt nội bộ, module OIDC của Overleaf sử dụng thư viện passport-openidconnect. Nếu bạn gặp vấn đề khi cấu hình OpenID Connect, bạn nên đọc README củapassport-openidconnect để nắm được cấu hình mà thư viện này mong đợi.
Biến môi trường EXTERNAL_AUTH là bắt buộc để bật module xác thực OIDC. Biến môi trường này chỉ định những phương thức xác thực bên ngoài nào được kích hoạt. Giá trị của biến này là một danh sách. Nếu danh sách bao gồm oidc thì xác thực OIDC sẽ được kích hoạt.
Ví dụ: EXTERNAL_AUTH=ldap oidc
Khi sử dụng phương thức xác thực OIDC, người dùng sẽ được chuyển hướng đến trang xác thực của Nhà cung cấp định danh (IdP). Nếu IdP xác thực người dùng thành công, cơ sở dữ liệu người dùng Overleaf sẽ được kiểm tra để tìm bản ghi có trường thirdPartyIdentifiers với cấu trúc như sau:
externalUserId phải khớp với ID người dùng trong hồ sơ do máy chủ IdP trả về (xem biến môi trường OVERLEAF_OIDC_USER_ID_FIELD), và providerId phải khớp với ID của nhà cung cấp OIDC (xem OVERLEAF_OIDC_PROVIDER_ID).
Nếu không tìm thấy bản ghi phù hợp, cơ sở dữ liệu sẽ được tìm kiếm để tìm người dùng có địa chỉ email chính khớp với email trong hồ sơ người dùng của IdP:
- Nếu tìm thấy người dùng như vậy, trường
thirdPartyIdentifierssẽ được cập nhật. - Nếu không tìm thấy người dùng phù hợp và tính năng tạo tài khoản JIT không bị tắt, một người dùng mới sẽ được tạo với địa chỉ email và
thirdPartyIdentifierslấy từ hồ sơ IdP.
/user/settings.
Tìm các giá trị bằng tài liệu discovery
Mọi Nhà cung cấp OpenID (OP) đều công bố một tài liệu discovery tại<issuer>/.well-known/openid-configuration. Hãy sao chép các giá trị từ tài liệu này thay vì gõ tay; chỉ cần sai một ký tự là đủ khiến việc đăng nhập thất bại.
Tìm URL discovery

Authentik: URL discovery và issuer của một provider (phiên bản thử nghiệm)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Đọc các giá trị

Authentik: các endpoint của một provider (phiên bản thử nghiệm)
Sao chép chúng vào variables.env
Kiểm tra Overleaf có thể kết nối tới OP
200.Biến môi trường
Giá trị của năm biến bắt buộc sau đây có thể được tìm thấy thông qua endpoint.well-known/openid-configuration của Nhà cung cấp OpenID (OP) của bạn, xem ở trên.
OVERLEAF_OIDC_ISSUER(bắt buộc)OVERLEAF_OIDC_AUTHORIZATION_URL(bắt buộc)OVERLEAF_OIDC_TOKEN_URL(bắt buộc)OVERLEAF_OIDC_USER_INFO_URL(bắt buộc)OVERLEAF_OIDC_LOGOUT_URL(bắt buộc)
OVERLEAF_OIDC_CLIENT_ID(bắt buộc)OVERLEAF_OIDC_CLIENT_SECRET(bắt buộc)OVERLEAF_OIDC_SCOPE- Mặc định:
openid profile email
- Mặc định:
OVERLEAF_OIDC_PROVIDER_ID- ID tùy ý của OP, mặc định là
oidc.
- ID tùy ý của OP, mặc định là
OVERLEAF_OIDC_PROVIDER_NAME- Tên của OP, được dùng trong phần
Linked Accountscủa trang/user/settings, mặc định làOIDC Provider.
- Tên của OP, được dùng trong phần
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Tên hiển thị của dịch vụ định danh, được dùng trên trang đăng nhập (mặc định:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Tên hiển thị của dịch vụ định danh, được dùng trên trang đăng nhập (mặc định:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Mô tả về OP, được dùng trong phần
Linked Accounts(mặc định:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Mô tả về OP, được dùng trong phần
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL
Learn moretrong phần mô tả OP; mặc định: không có liên kếtLearn moretrong phần mô tả.
- URL
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Không hiển thị OP trên trang
/user/settingsnếu tài khoản của người dùng chưa được liên kết với OP, mặc định làfalse.
- Không hiển thị OP trên trang
OVERLEAF_OIDC_USER_ID_FIELD- Giá trị của thuộc tính này sẽ được Overleaf dùng làm ID người dùng bên ngoài, mặc định là
id. Các giá trị hợp lý khác có thể dùng làemailvàusername(tương ứng với claim OIDCpreferred_username).
- Giá trị của thuộc tính này sẽ được Overleaf dùng làm ID người dùng bên ngoài, mặc định là
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Giới hạn việc tạo tài khoản Just-in-Time (JIT) cho người dùng xác thực qua OIDC. Nếu được đặt thành một danh sách tên miền phân tách bằng dấu phẩy, tài khoản mới sẽ chỉ được tạo nếu tên miền trong địa chỉ email của người dùng khớp với một trong các tên miền được liệt kê. Nếu tên miền không khớp, quản trị viên phải tạo tài khoản người dùng thủ công bằng địa chỉ email của người dùng OIDC, với một mật khẩu ngẫu nhiên mạnh hoặc tốt hơn là hoàn toàn không có trường
hashedPassword. Tên miền có thể bắt đầu bằng ký tự đại diện*.để khớp với các tên miền con.- Ví dụ: Để cho phép tạo tài khoản JIT cho người dùng có địa chỉ email như
name@example.comvàname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Ví dụ: Để tắt hoàn toàn việc tạo tài khoản JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Ví dụ: Để cho phép tạo tài khoản JIT cho người dùng có địa chỉ email như
- Giới hạn việc tạo tài khoản Just-in-Time (JIT) cho người dùng xác thực qua OIDC. Nếu được đặt thành một danh sách tên miền phân tách bằng dấu phẩy, tài khoản mới sẽ chỉ được tạo nếu tên miền trong địa chỉ email của người dùng khớp với một trong các tên miền được liệt kê. Nếu tên miền không khớp, quản trị viên phải tạo tài khoản người dùng thủ công bằng địa chỉ email của người dùng OIDC, với một mật khẩu ngẫu nhiên mạnh hoặc tốt hơn là hoàn toàn không có trường
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Nếu được đặt thành
true, các trườngfirst_namevàlast_namecủa người dùng sẽ được cập nhật khi đăng nhập, và biểu mẫu thông tin người dùng trên trang/user/settingssẽ bị vô hiệu hóa.
- Nếu được đặt thành
OVERLEAF_OIDC_IS_ADMIN_FIELDvàOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Khi cả hai biến môi trường này đều được đặt, quá trình đăng nhập sẽ cập nhật
user.isAdmin = truenếu hồ sơ do OP trả về chứa thuộc tính được chỉ định bởiOVERLEAF_OIDC_IS_ADMIN_FIELDvà giá trị của nó hoặc khớp vớiOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE, hoặc là một mảng chứaOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(ví dụ claimgroups); nếu không,user.isAdminsẽ được đặt thànhfalse. NếuOVERLEAF_OIDC_IS_ADMIN_FIELDlàemailthì giá trị của thuộc tínhemails[0].valuesẽ được dùng để kiểm tra khớp.
- Khi cả hai biến môi trường này đều được đặt, quá trình đăng nhập sẽ cập nhật
https://my-overleaf-instance.com/oidc/login/callback.
Tệp variables.env mẫu
Tệp variables.env mẫu
Hướng dẫn từng bước: goauthentik
Phần này hướng dẫn một cấu hình đã được kiểm thử với goauthentik. Hãy thayhttps://overleaf.example.com bằng OVERLEAF_SITE_URL của bạn và https://authentik.example.com bằng địa chỉ Authentik của bạn.
Tạo provider
- Client Type:
Confidential. - Redirect URIs (trong Protocol settings): thêm
https://overleaf.example.com/oidc/login/callbackvới chế độ khớpStrict. - Sao chép ngay Client ID và Client Secret vào
OVERLEAF_OIDC_CLIENT_IDvàOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID và Client Secret của một provider mới
Tạo application
overleaf, rồi chọn provider. Slug sẽ trở thành một phần của issuer: https://authentik.example.com/application/o/overleaf/.Sao chép các URL
Ánh xạ quản trị viên (tùy chọn)
groups, là một mảng. Để các thành viên của nhóm Authentik Admins trở thành quản trị viên Overleaf:Tệp variables.env đã kiểm thử cho goauthentik
Tệp variables.env đã kiểm thử cho goauthentik
Hỏi & Đáp
Claim admin đã được đặt, nhưng người dùng không trở thành quản trị viên
Claim admin đã được đặt, nhưng người dùng không trở thành quản trị viên
- Phiên bản. Trước v6.3.0, Overleaf không đọc các claim tùy chỉnh như
groups, nên chỉOVERLEAF_OIDC_IS_ADMIN_FIELD=emailhoạt động. Hãy nâng cấp lên v6.3.0 trở lên. - Claim phải có trong phản hồi UserInfo. Overleaf đọc claim từ
OVERLEAF_OIDC_USER_INFO_URL, không phải từ ID token. Nếu OP của bạn chỉ thêm claim vào ID token, hãy thêm nó vào cả UserInfo, ví dụ bằng tùy chọn Add to userinfo trên một mapper của Keycloak. - Giá trị phải khớp chính xác, kể cả chữ hoa chữ thường, ví dụ
Admins.
Tôi có thể dùng GitHub làm nhà cung cấp OIDC không?
Tôi có thể dùng GitHub làm nhà cung cấp OIDC không?
ID token not present in token response.Để cho phép người dùng đăng nhập bằng tài khoản GitHub, hãy dùng một nhà cung cấp danh tính như goauthentik hoặc Keycloak, với GitHub là nguồn đăng nhập, rồi kết nối Overleaf với nhà cung cấp đó qua OIDC.Tôi có thể dùng GitLab làm nhà cung cấp OIDC không?
Tôi có thể dùng GitLab làm nhà cung cấp OIDC không?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profilevàemail
https://gitlab.com/.well-known/openid-configuration, hoặc từ cùng đường dẫn đó trên GitLab của bạn, như mô tả trong Tìm các giá trị bằng tài liệu discovery. Với gitlab.com, issuer là https://gitlab.com, không có dấu gạch chéo ở cuối.
