Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Apple

Aprende a configurar LibreChat para usar Apple para la autenticación de usuarios.

Requisitos previos

Antes de comenzar, asegúrese de tener lo siguiente:

  • Cuenta de desarrollador de Apple: Si no tienes una, regístrate aquí.

Creación de un nuevo App ID

1. Inicia sesión en la Apple Developer Console

2. Navegar a Identifiers

  • Ve a Certificates, Identifiers & Profiles.
  • Haz clic en Identifiers en la barra lateral.

3. Crear un nuevo App ID

  1. Haz clic en el botón "+" para añadir un nuevo identificador.
  2. Seleccione App IDs y haga clic en Continue.
  3. Elija App y haga clic en Continue.
  4. Ingrese una Description para su App ID (por ejemplo, LibreChat App ID).
  5. Establezca el Bundle ID (por ejemplo, com.yourdomain.librechat).
  6. Haz clic en Continue y luego en Register.
  • Referencias de imágenes:

  • Create App ID Figura 1: Creación de un nuevo App ID

  • Select App Figura 2: Selección del identificador de la aplicación

4. Habilitar "Sign in with Apple"

  1. Después de crear el App ID, haz clic en él para editarlo.
  2. Bajo Capabilities, busca y marca Sign in with Apple.
  3. Haz clic en Save.
  • Referencia de imagen:
  • Enable Sign in with Apple Figura 3: Habilitar "Sign in with Apple"

Creación de un Services ID

1. Navegar a Identifiers

  • En la sección Certificates, Identifiers & Profiles, haga clic en Identifiers.

2. Crear un nuevo Services ID

  1. Haz clic en el botón "+".
  2. Selecciona Services IDs y haz clic en Continue.
  3. Ingrese una Description (p. ej., LibreChat Services ID).
  4. Ingrese un Identificador (p. ej., com.yourdomain.librechat.services).
  5. Haz clic en Continue y luego en Register.
  • Referencias de imágenes:

  • Select Services ID Figura 4: Selección del ID de servicios

  • Create Services ID Figura 5: Creación del ID de servicios

3. Configurar "Sign in with Apple"

  1. Haz clic en el Services ID recién creado.
  2. En Capabilities, haga clic en Configure junto a Sign in with Apple.
  3. Ingrese sus Domains (p. ej., your-domain.com) y Return URLs (p. ej., https://your-domain.com/oauth/apple/callback).
  4. Haz clic en Next y luego en Register.
  • Referencia de imagen:

  • Configure Sign in with Apple Figura 6: Configuración de "Sign in with Apple" para Services ID

  • Configuración de autenticación web Figura 7: Configuración de autenticación web

  • Web Authentication Configuration Figura 8: Guardar la configuración del ID de servicios de edición


Creación de una clave

1. Navegar a Keys

  • En la sección Certificates, Identifiers & Profiles, haga clic en Keys.

2. Crear una nueva clave

  1. Haz clic en el botón "+" para añadir una nueva clave.
  2. Ingrese un Key Name (por ejemplo, LibreChatSignInWithApple).
  3. Seleccione Sign in with Apple en Capabilities.
  4. Haz clic en Configure y selecciona el App ID creado (por ejemplo, com.yourdomain.librechat), luego haz clic en Save.
  5. Haz clic en Continue y luego en Register.
  • Referencias de imágenes:

  • Create Key Figura 8: Creación de una nueva clave

  • Configure Key Figura 9: Configuración de la Key con el App ID

  • Register a New Key Figura 10: Registro de la clave

3. Descargar la clave privada

  1. Después de crear la clave, haz clic en Download.
  2. Importante: Guarde el archivo .p8 de forma segura. No podrá volver a descargarlo.
  3. Tenga en cuenta el Key ID; lo necesitará para el archivo .env.
  • Referencia de imagen:
  • Download Your Key Figura 11: Descarga de la clave privada

Configurando LibreChat

1. Actualizar la configuración de .env

Agregue la siguiente configuración de Apple OAuth2 a su archivo .env:

DOMAIN_CLIENT=https://your-domain.com # use http://localhost:3080 if not using a custom domain
DOMAIN_SERVER=https://your-domain.com # use http://localhost:3080 if not using a custom domain

# Apple
APPLE_CLIENT_ID=com.yourdomain.librechat.services
APPLE_TEAM_ID=YOUR_TEAM_ID
APPLE_KEY_ID=YOUR_KEY_ID
APPLE_PRIVATE_KEY_PATH=/path/to/AuthKey.p8 # Absolute path to your downloaded .p8 file
APPLE_CALLBACK_URL=/oauth/apple/callback

Nota:

  • Reemplace com.yourdomain.librechat.services con su ID de servicios real.
  • Reemplace YOUR_TEAM_ID y YOUR_KEY_ID con los valores respectivos de su cuenta de Apple Developer.
  • Si utiliza Docker, asegúrese de que el archivo .p8 sea accesible dentro de su contenedor Docker y actualice APPLE_PRIVATE_KEY_PATH en consecuencia.

2. Reiniciar LibreChat

Después de actualizar el archivo .env, reinicia LibreChat para aplicar los cambios.

  • Si utiliza Docker:
docker compose up -d

Solución de problemas

Si encuentra problemas durante la configuración, considere las siguientes soluciones:

  • URI de redirección no válida:

    • Asegúrese de que el URI de redireccionamiento en su Apple Developer Console (https://your-domain.com/oauth/apple/callback) coincida exactamente con el especificado en su archivo .env (APPLE_CALLBACK_URL).
  • Problemas con la clave privada:

    • Verifique que la ruta a su archivo .p8 (APPLE_PRIVATE_KEY_PATH) sea correcta.
    • Asegúrate de que LibreChat tenga permisos de lectura para el archivo .p8.
  • Errores de Team ID y Key ID:

    • Verifica dos veces que el APPLE_TEAM_ID y el APPLE_KEY_ID en tu archivo .env coincidan con los de tu cuenta de Apple Developer.
  • Error en la verificación del dominio:

    • Asegúrese de que el archivo de verificación esté correctamente cargado en la raíz de su dominio.
    • Verifique que no haya errores tipográficos en el nombre de dominio ingresado durante la configuración.
  • Problemas de configuración de Docker:

    • Si utiliza Docker, confirme que el archivo .p8 esté montado correctamente y que la ruta en APPLE_PRIVATE_KEY_PATH sea accesible dentro del contenedor.
  • Revisar registros:

    • Revise los registros de LibreChat en busca de cualquier mensaje de error relacionado con la autenticación de Apple. Esto puede proporcionar información específica sobre lo que podría estar fallando.

¿Qué te parece esta guía?