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
- Ação:
- Visite o Apple Developer e faça login com seu Apple ID.
2. Navegue até Identifiers
- Vá para Certificates, Identifiers & Profiles.
- Clique em Identifiers na barra lateral.
3. Criar um novo App ID
- Clique no botão "+" para adicionar um novo identificador.
- Selecione App IDs e clique em Continue.
- Escolha App e clique em Continue.
- Insira uma Descrição para o seu App ID (por exemplo,
LibreChat App ID). - Defina o Bundle ID (por exemplo,
com.yourdomain.librechat). - Clique em Continue e depois em Register.
-
Referências de Imagem:
-
Figura 1: Criando um novo App ID -
Figura 2: Selecionando o Identificador do App
4. Habilitar "Sign in with Apple"
- Após criar o App ID, clique nele para editar.
- Em Capabilities, localize e marque Sign in with Apple.
- Clique em Save.
- Referência de Imagem:
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
- Clique no botão "+".
- Selecione Services IDs e clique em Continue.
- Insira uma Description (por exemplo,
LibreChat Services ID). - Insira um Identificador (por exemplo,
com.yourdomain.librechat.services). - Clique em Continue e depois em Register.
-
Referências de Imagem:
-
Figura 4: Selecionando o ID de Serviços -
Figura 5: Criando o Services ID
3. Configure o "Sign in with Apple"
- Clique no Services ID recém-criado.
- Em Capabilities, clique em Configure ao lado de Sign in with Apple.
- Insira seus Domains (ex:
your-domain.com) e Return URLs (ex:https://your-domain.com/oauth/apple/callback). - Clique em Next e depois em Register.
-
Referência de Imagem:
-
Figura 6: Configurando "Sign in with Apple" para Services ID
-
Figura 7: 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
- Clique no botão "+" para adicionar uma nova chave.
- Insira um Key Name (por exemplo,
LibreChatSignInWithApple). - Selecione Sign in with Apple em Capabilities.
- Clique em Configure e selecione o App ID criado (por exemplo,
com.yourdomain.librechat), depois clique em Save. - Clique em Continue e depois em Register.
-
Referências de Imagem:
-
Figura 8: Criando uma Nova Chave
-
Figura 9: Configurando a Chave com o App ID
-
Figura 10: Registrando a chave
3. Baixe a Chave Privada
- Após criar a chave, clique em Download.
- Importante: Salve o arquivo
.p8de forma segura. Você não poderá baixá-lo novamente. - Observe o Key ID; você precisará dele para o arquivo
.env.
- Referência de Imagem:
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/callbackNota:
- Substitua
com.yourdomain.librechat.servicespelo seu ID de Serviços real.- Substitua
YOUR_TEAM_IDeYOUR_KEY_IDpelos respectivos valores da sua conta de desenvolvedor Apple.- Se estiver usando Docker, certifique-se de que o arquivo
.p8esteja acessível dentro do seu container Docker e atualize oAPPLE_PRIVATE_KEY_PATHadequadamente.
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 -dSoluçã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).
- Certifique-se de que o URI de redirecionamento no seu Apple Developer Console (
-
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.
- Verifique se o caminho para o seu arquivo
-
Erros de Team ID e Key ID:
- Verifique duas vezes se o
APPLE_TEAM_IDe oAPPLE_KEY_IDno seu arquivo.envcorrespondem aos da sua conta de desenvolvedor Apple.
- Verifique duas vezes se o
-
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
.p8está montado corretamente e se o caminho emAPPLE_PRIVATE_KEY_PATHestá acessível dentro do container.
- Se estiver usando Docker, confirme se o arquivo
-
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?