Migrar para LDAP ou SAML

{
  _id:        '123',
  email:      '[e-mail]'
  first_name: 'Alice',
  last_name:  'Jones'
}

Agora, você quer integrar o sistema ao LDAP/Active Directory da sua empresa. Nesse sistema, os dados de Alice são:

Alice:
  - uid:  'alicejones'
  - mail: '[e-mail]'
  - givenName:   'Alice'
  - sn: 'Jones'

Seu objetivo é fazer com que Alice faça login com o nome de usuário LDAP (alicejones) e a senha correspondente, em vez das antigas credenciais do Overleaf, sem perder nenhum trabalho. Veja como fazer isso.

Este processo exigirá a recriação do contêiner sharelatex, o que resultará em algum tempo de indisponibilidade. Recomendamos fortemente que você se familiarize com o processo executando-o primeiro em um ambiente de teste/homologação.

1. Peça aos usuários que atualizem seus endereços de e-mail

   As contas do Overleaf estão vinculadas a endereços de e-mail, portanto o primeiro passo é sincronizar os e-mails dos usuários no Overleaf com os e-mails do LDAP ou SAML.

   No nosso exemplo, você pediria a Alice que entrasse na conta do Overleaf e alterasse o e-mail de [e-mail] para [e-mail].

   Não se esqueça de você mesmo! Se você é administrador, também precisará atualizar o seu próprio endereço de e-mail.

   Se você tiver muitos usuários, pode usar o script de migração de nomes de usuário para alterar em massa o endereço de e-mail principal dos usuários.

2. Habilite o módulo LDAP ou SAML

   Depois que os endereços de e-mail de todos forem atualizados, é hora de virar a chave! Você precisará definir as variáveis de ambiente adequadas para o novo método de autenticação e, em seguida, recriar o contêiner sharelatex usando o comando bin/up -d.

   Isso substitui o formulário de login padrão do Overleaf pelo novo formulário LDAP ou SAML.

   Você encontra as informações para habilitar o LDAP aqui e o SAML 2.0 aqui.

3. Os usuários já podem fazer login via LDAP ou SAML

   Na próxima vez que Alice for fazer login, verá o novo formulário.

   

   Ela pode informar o nome de usuário LDAP (alicejones) e a senha e, como o endereço de e-mail agora corresponde ao do LDAP, entrará diretamente na conta existente do Overleaf. Todos os projetos estarão exatamente onde ela os deixou.

   Se você habilitou o SAML 2.0, os usuários verão um botão que, ao ser clicado, os redireciona ao seu IdP para inserir as credenciais. Após a autenticação bem-sucedida, eles serão redirecionados de volta à sua instância do Overleaf e conectados à conta.

   

   Consulte a página Variáveis de ambiente para obter informações sobre como personalizar a experiência da página de login.

   E, se algum dia precisar reverter, basta comentar a configuração de LDAP/SAML e recriar o contêiner sharelatex usando o comando bin/up -d. Os usuários poderão então fazer login com o endereço de e-mail atual e a senha específica do Overleaf.

​

O caminho inverso: voltar do LDAP/SAML para a autenticação nativa

E se você usa LDAP ou SAML há algum tempo e quer passar para o sistema de login integrado do Overleaf (talvez porque desativou seu LDAP)? Sem problemas! Veja como fazer essa mudança.

1. Verifique se o e-mail de todos está correto

   As contas dos usuários já estão vinculadas aos endereços de e-mail do LDAP ou SAML. Esse é o e-mail que eles usarão para fazer login daqui em diante, então apenas certifique-se de que tudo esteja correto.

2. Desabilite o módulo LDAP ou SAML

   Basta remover ou desfazer as configurações de LDAP/SAML e recriar o contêiner sharelatex usando o comando bin/up -d. Isso trará de volta o formulário de login nativo do Overleaf com e-mail e senha.

   
3. Peça aos usuários que redefinam suas senhas

   Quando os usuários acessarem a página de login, verão o formulário de login do Overleaf em vez do formulário LDAP/SAML.

   Como talvez nunca tenham tido uma senha nativa do Overleaf, eles precisarão criar uma. Cada usuário deve:

   • Clicar no link “Forgot your password?”.
   • Informar o endereço de e-mail associado à conta (o do LDAP/SAML).
   • Seguir o link do e-mail de redefinição de senha para definir uma nova senha.

   Se ainda não fez isso, consulte nosso guia sobre como habilitar o envio de e-mails.

   Depois disso, eles poderão fazer login com o e-mail e a nova senha específica do Overleaf para acessar todos os seus projetos.