Configuración
Internamente, el módulo OIDC de Overleaf utiliza la biblioteca passport-openidconnect. Si tienes problemas para configurar OpenID Connect, vale la pena leer el README depassport-openidconnect para hacerte una idea de la configuración que espera.
La variable de entorno EXTERNAL_AUTH es necesaria para habilitar el módulo de autenticación OIDC. Esta variable de entorno especifica qué métodos de autenticación externa se activan. Su valor es una lista. Si la lista incluye oidc, se activará la autenticación OIDC.
Por ejemplo: EXTERNAL_AUTH=ldap oidc
Al utilizar el método de autenticación OIDC, el usuario es redirigido al sitio de autenticación del proveedor de identidad (IdP). Si el IdP autentica correctamente al usuario, se busca en la base de datos de usuarios de Overleaf un registro que contenga un campo thirdPartyIdentifiers con la siguiente estructura:
externalUserId debe coincidir con el ID de usuario del perfil devuelto por el servidor del IdP (consulta la variable de entorno OVERLEAF_OIDC_USER_ID_FIELD), y providerId debe coincidir con el ID del proveedor OIDC (consulta OVERLEAF_OIDC_PROVIDER_ID).
Si no se encuentra ningún registro coincidente, se busca en la base de datos un usuario cuya dirección de correo electrónico principal coincida con el correo del perfil de usuario del IdP:
- Si se encuentra dicho usuario, se actualiza el campo
thirdPartyIdentifiers. - Si no se encuentra ningún usuario coincidente y la creación de cuentas JIT no está deshabilitada, se crea un nuevo usuario con la dirección de correo electrónico y los
thirdPartyIdentifiersdel perfil del IdP.
/user/settings.
Encontrar los valores con el documento de descubrimiento
Todo proveedor de OpenID (OP) publica un documento de descubrimiento en<issuer>/.well-known/openid-configuration. Copia los valores de ahí en lugar de escribirlos a mano; basta un carácter incorrecto para que el inicio de sesión falle.
Encontrar la URL de descubrimiento

Authentik: la URL de descubrimiento y el emisor de un proveedor (instancia de prueba)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Leer los valores

Authentik: los endpoints de un proveedor (instancia de prueba)
Copiarlos en variables.env
Comprobar que Overleaf puede acceder al OP
200.Variables de entorno
Los valores de las siguientes cinco variables obligatorias pueden obtenerse a través del endpoint.well-known/openid-configuration de tu proveedor de OpenID (OP); consulta la sección anterior.
OVERLEAF_OIDC_ISSUER(obligatoria)OVERLEAF_OIDC_AUTHORIZATION_URL(obligatoria)OVERLEAF_OIDC_TOKEN_URL(obligatoria)OVERLEAF_OIDC_USER_INFO_URL(obligatoria)OVERLEAF_OIDC_LOGOUT_URL(obligatoria)
OVERLEAF_OIDC_CLIENT_ID(obligatoria)OVERLEAF_OIDC_CLIENT_SECRET(obligatoria)OVERLEAF_OIDC_SCOPE- Valor predeterminado:
openid profile email
- Valor predeterminado:
OVERLEAF_OIDC_PROVIDER_ID- ID arbitrario del OP; por defecto,
oidc.
- ID arbitrario del OP; por defecto,
OVERLEAF_OIDC_PROVIDER_NAME- El nombre del OP, que se usa en la sección
Linked Accountsde la página/user/settings; por defecto,OIDC Provider.
- El nombre del OP, que se usa en la sección
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Nombre visible del servicio de identidad, que se usa en la página de inicio de sesión (por defecto:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Nombre visible del servicio de identidad, que se usa en la página de inicio de sesión (por defecto:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Descripción del OP, que se usa en la sección
Linked Accounts(por defecto:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Descripción del OP, que se usa en la sección
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL de
Learn moreen la descripción del OP; por defecto, la descripción no incluye ningún enlaceLearn more.
- URL de
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- No mostrar el OP en la página
/user/settingssi la cuenta del usuario no está vinculada con el OP; por defecto,false.
- No mostrar el OP en la página
OVERLEAF_OIDC_USER_ID_FIELD- Overleaf usará el valor de este atributo como ID de usuario externo; por defecto,
id. Otros valores razonables posibles sonemailyusername(correspondiente al claim OIDCpreferred_username).
- Overleaf usará el valor de este atributo como ID de usuario externo; por defecto,
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Restringe la creación de cuentas Just-in-Time (JIT) para los usuarios que se autentican mediante OIDC. Si se establece en una lista de nombres de dominio separados por comas, solo se creará una cuenta nueva si el dominio de la dirección de correo electrónico del usuario coincide con uno de los dominios de la lista. Si el dominio no coincide, un administrador debe crear manualmente la cuenta de usuario con la dirección de correo electrónico del usuario OIDC, ya sea con una contraseña aleatoria segura o, preferiblemente, sin el campo
hashedPassword. Los nombres de dominio pueden incluir un comodín*.inicial para coincidir con subdominios.- Ejemplo: para permitir la creación de cuentas JIT a usuarios con direcciones de correo como
name@example.comyname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Ejemplo: para deshabilitar por completo la creación de cuentas JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Ejemplo: para permitir la creación de cuentas JIT a usuarios con direcciones de correo como
- Restringe la creación de cuentas Just-in-Time (JIT) para los usuarios que se autentican mediante OIDC. Si se establece en una lista de nombres de dominio separados por comas, solo se creará una cuenta nueva si el dominio de la dirección de correo electrónico del usuario coincide con uno de los dominios de la lista. Si el dominio no coincide, un administrador debe crear manualmente la cuenta de usuario con la dirección de correo electrónico del usuario OIDC, ya sea con una contraseña aleatoria segura o, preferiblemente, sin el campo
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Si se establece en
true, actualiza los camposfirst_nameylast_namedel usuario al iniciar sesión y deshabilita el formulario de datos del usuario en la página/user/settings.
- Si se establece en
OVERLEAF_OIDC_IS_ADMIN_FIELDyOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Cuando ambas variables de entorno están definidas, el proceso de inicio de sesión establece
user.isAdmin = truesi el perfil devuelto por el OP contiene el atributo especificado enOVERLEAF_OIDC_IS_ADMIN_FIELDy su valor coincide conOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEo es un array que contieneOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(por ejemplo, el claimgroups); en caso contrario,user.isAdminse establece enfalse. SiOVERLEAF_OIDC_IS_ADMIN_FIELDesemail, se utiliza el valor del atributoemails[0].valuepara la comprobación.
- Cuando ambas variables de entorno están definidas, el proceso de inicio de sesión establece
https://my-overleaf-instance.com/oidc/login/callback.
Ejemplo de archivo variables.env
Ejemplo de archivo variables.env
Paso a paso: goauthentik
Esta guía describe una configuración probada con goauthentik. Sustituyehttps://overleaf.example.com por tu OVERLEAF_SITE_URL y https://authentik.example.com por la dirección de tu Authentik.
Crear el proveedor
- Client Type:
Confidential. - Redirect URIs (en Protocol settings): añade
https://overleaf.example.com/oidc/login/callbackcon el modo de coincidenciaStrict. - Copia ahora Client ID y Client Secret en
OVERLEAF_OIDC_CLIENT_IDyOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID y Client Secret de un nuevo proveedor
Crear la aplicación
overleaf, y selecciona el proveedor. El slug pasa a formar parte del emisor: https://authentik.example.com/application/o/overleaf/.Copiar las URL
Asignar los administradores (opcional)
groups, que es un array. Para que los miembros del grupo Admins de Authentik sean administradores de Overleaf:Archivo variables.env probado para goauthentik
Archivo variables.env probado para goauthentik
Preguntas y respuestas
El claim de administrador está configurado, pero los usuarios no se convierten en administradores
El claim de administrador está configurado, pero los usuarios no se convierten en administradores
- Versión. Antes de v6.3.0, Overleaf no leía claims personalizados como
groups, así que solo funcionabaOVERLEAF_OIDC_IS_ADMIN_FIELD=email. Actualiza a v6.3.0 o posterior. - El claim debe estar en la respuesta de UserInfo. Overleaf lee el claim de
OVERLEAF_OIDC_USER_INFO_URL, no del ID token. Si tu OP añade el claim solo al ID token, añádelo también a UserInfo, por ejemplo con Add to userinfo en un mapper de Keycloak. - El valor debe coincidir exactamente, incluidas mayúsculas y minúsculas, por ejemplo
Admins.
¿Puedo usar GitHub como proveedor OIDC?
¿Puedo usar GitHub como proveedor OIDC?
ID token not present in token response.Para que los usuarios inicien sesión con su cuenta de GitHub, usa un proveedor de identidad como goauthentik o Keycloak, con GitHub como fuente de inicio de sesión, y conecta Overleaf a ese proveedor mediante OIDC.¿Puedo usar GitLab como proveedor OIDC?
¿Puedo usar GitLab como proveedor OIDC?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileyemail
https://gitlab.com/.well-known/openid-configuration, o de la misma ruta en tu GitLab, como se describe en Encontrar los valores con el documento de descubrimiento. Para gitlab.com, el issuer es https://gitlab.com, sin barra final.
