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

Apple

Aprenda a configurar o LibreChat para usar a Apple para autenticação de usuários.

Pré-requisitos

Antes de começar, certifique-se de ter o seguinte:

  • Conta de Desenvolvedor Apple: Se você não possui uma, inscreva-se aqui.

Criando um novo App ID

1. Faça login no Apple Developer Console

2. Navegue até Identifiers

  • Vá para Certificates, Identifiers & Profiles.
  • Clique em Identifiers na barra lateral.

3. Criar um novo App ID

  1. Clique no botão "+" para adicionar um novo identificador.
  2. Selecione App IDs e clique em Continue.
  3. Escolha App e clique em Continue.
  4. Insira uma Descrição para o seu App ID (por exemplo, LibreChat App ID).
  5. Defina o Bundle ID (por exemplo, com.yourdomain.librechat).
  6. Clique em Continue e depois em Register.
  • Referências de Imagem:

  • Create App ID Figura 1: Criando um novo App ID

  • Select App Figura 2: Selecionando o Identificador do App

4. Habilitar "Sign in with Apple"

  1. Após criar o App ID, clique nele para editar.
  2. Em Capabilities, localize e marque Sign in with Apple.
  3. Clique em Save.
  • Referência de Imagem:
  • Enable Sign in with Apple Figura 3: Habilitando "Sign in with Apple"

Criando um Services ID

1. Navegue até Identifiers

  • Na seção Certificates, Identifiers & Profiles, clique em Identifiers.

2. Criar um novo Services ID

  1. Clique no botão "+".
  2. Selecione Services IDs e clique em Continue.
  3. Insira uma Description (por exemplo, LibreChat Services ID).
  4. Insira um Identificador (por exemplo, com.yourdomain.librechat.services).
  5. Clique em Continue e depois em Register.
  • Referências de Imagem:

  • Select Services ID Figura 4: Selecionando o ID de Serviços

  • Create Services ID Figura 5: Criando o Services ID

3. Configure o "Sign in with Apple"

  1. Clique no Services ID recém-criado.
  2. Em Capabilities, clique em Configure ao lado de Sign in with Apple.
  3. Insira seus Domains (ex: your-domain.com) e Return URLs (ex: https://your-domain.com/oauth/apple/callback).
  4. Clique em Next e depois em Register.
  • Referência de Imagem:

  • Configure Sign in with Apple Figura 6: Configurando "Sign in with Apple" para Services ID

  • Configuração de Autenticação Web Figura 7: Configuração de Autenticação Web

  • Configuração de Autenticação Web Figura 8: Salvar edição da Configuração de ID de Serviços


Criando uma Chave

1. Navegue até Keys

  • Na seção Certificates, Identifiers & Profiles, clique em Keys.

2. Criar uma Nova Chave

  1. Clique no botão "+" para adicionar uma nova chave.
  2. Insira um Key Name (por exemplo, LibreChatSignInWithApple).
  3. Selecione Sign in with Apple em Capabilities.
  4. Clique em Configure e selecione o App ID criado (por exemplo, com.yourdomain.librechat), depois clique em Save.
  5. Clique em Continue e depois em Register.
  • Referências de Imagem:

  • Create Key Figura 8: Criando uma Nova Chave

  • Configure Key Figura 9: Configurando a Chave com o App ID

  • Register a New Key Figura 10: Registrando a chave

3. Baixe a Chave Privada

  1. Após criar a chave, clique em Download.
  2. Importante: Salve o arquivo .p8 de forma segura. Você não poderá baixá-lo novamente.
  3. Observe o Key ID; você precisará dele para o arquivo .env.
  • Referência de Imagem:
  • Download Your Key Figura 11: Baixando a Chave Privada

Configurando o LibreChat

1. Atualizar a configuração do .env

Adicione a seguinte configuração de OAuth2 da Apple ao seu arquivo .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:

  • Substitua com.yourdomain.librechat.services pelo seu ID de Serviços real.
  • Substitua YOUR_TEAM_ID e YOUR_KEY_ID pelos respectivos valores da sua conta de desenvolvedor Apple.
  • Se estiver usando Docker, certifique-se de que o arquivo .p8 esteja acessível dentro do seu container Docker e atualize o APPLE_PRIVATE_KEY_PATH adequadamente.

2. Reinicie o LibreChat

Após atualizar o arquivo .env, reinicie o LibreChat para aplicar as alterações.

  • Se estiver usando Docker:
docker compose up -d

Solução de problemas

Se você encontrar problemas durante a configuração, considere as seguintes soluções:

  • URI de redirecionamento inválida:

    • Certifique-se de que o URI de redirecionamento no seu Apple Developer Console (https://your-domain.com/oauth/apple/callback) corresponda exatamente ao especificado no seu arquivo .env (APPLE_CALLBACK_URL).
  • Problemas com a Chave Privada:

    • Verifique se o caminho para o seu arquivo .p8 (APPLE_PRIVATE_KEY_PATH) está correto.
    • Certifique-se de que o LibreChat tenha permissões de leitura para o arquivo .p8.
  • Erros de Team ID e Key ID:

    • Verifique duas vezes se o APPLE_TEAM_ID e o APPLE_KEY_ID no seu arquivo .env correspondem aos da sua conta de desenvolvedor Apple.
  • Falha na Verificação de Domínio:

    • Certifique-se de que o arquivo de verificação esteja carregado corretamente na raiz do seu domínio.
    • Verifique se não há erros de digitação no nome de domínio inserido durante a configuração.
  • Problemas de Configuração do Docker:

    • Se estiver usando Docker, confirme se o arquivo .p8 está montado corretamente e se o caminho em APPLE_PRIVATE_KEY_PATH está acessível dentro do container.
  • Verificar logs:

    • Revise os logs do LibreChat em busca de mensagens de erro relacionadas à autenticação da Apple. Isso pode fornecer informações específicas sobre o que pode estar ocorrendo de errado.

Como está este guia?