Gerenciamento de usuários

Criar um usuário administrador

Implantações com o Overleaf Toolkit:

Overleaf Toolkit

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=joe@example.com"

Implantações legadas com docker-compose.yml:

Legacy docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=joe@example.com"

O comando criará um usuário com o endereço de e-mail fornecido, caso ainda não exista, e o tornará administrador. A saída do comando inclui uma URL que você deve visitar para definir a senha deste usuário e entrar pela primeira vez.

Para uma abordagem programática, você pode usar o mesmo script para criar usuários comuns, além de administradores. Para usuários comuns, omita a flag —admin.

Se você usa contas internas para autenticação e precisa promover um usuário existente a administrador da instância ou revogar permissões de administrador, faça o seguinte:

Pela interface de administração

Entre como um administrador existente.
Clique em Admin -> Manage Users.
Pesquise o usuário e clique no endereço de e-mail dele.
Role para baixo até a seção Site Admin e clique no link (show).
Marque a caixa Is Site Admin.
Clique em Save para concluir.

Excluir usuários

Em geral, é recomendável não excluir contas, a menos que não sejam mais necessárias. Excluir uma conta remove a conta e faz com que os colaboradores percam o acesso aos projetos. Atualmente não há como desativar contas — elas existem com os seus dados mantidos ou são excluídas. Por padrão, as contas são excluídas de forma reversível (soft delete). Para informações sobre como remover usuários permanentemente da sua instância, consulte ENABLE_CRON_RESOURCE_DELETION no guia de Variáveis de ambiente.

Por padrão, as contas são excluídas de forma reversível. Consulte ENABLE_CRON_RESOURCE_DELETION para o comportamento de exclusão permanente.

Através de Admin -> Manage Users

Entre como administrador.
Clique em Admin -> Manage Users.
Pesquise o usuário e marque a caixa ao lado do endereço de e-mail dele.
Clique no ícone da lixeira.
Clique em Delete para confirmar.

Pela linha de comando

As contas de usuário (e os seus projetos) podem ser excluídas usando os seguintes comandos. Implantações com o Overleaf Toolkit:

Overleaf Toolkit

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=joe@example.com"

Implantações legadas com docker-compose.yml:

Legacy docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=joe@example.com"

O script de exclusão usa uma opção de força fixa no código que garante que a exclusão prossiga mesmo que o e-mail de exclusão da conta não seja enviado (por exemplo, quando o e-mail do usuário não está mais em uso).

Desde a versão 5.5.0, a opção —skip-email pode ser usada para evitar o envio de um e-mail informativo ao usuário excluído.

Restaurar um usuário excluído de forma reversível

Se um usuário tiver sido apenas excluído de forma reversível, você pode restaurar a conta e os projetos dele.

Entre como administrador.
Clique em Admin -> Manage Users.
Pesquise o usuário que deseja restaurar.
Clique no botão Display deleted users.
Clique no endereço de e-mail do usuário excluído.
Clique em Recover This Account.
Clique em Recover para confirmar.

Quando ENABLE_CRON_RESOURCE_DELETION está definido como true, as contas excluídas de forma reversível podem ser restauradas dentro de um prazo de 90 dias. Após 90 dias, não é possível recuperar a conta.

Contar usuários

Você pode obter a contagem de usuários pela interface de administração em https://you-instance-url/admin/user#license. Para verificações e exportações programáticas, os exemplos a seguir podem ajudar. Número total de usuários:

Total number of users

echo 'db.users.countDocuments()' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 16

Número total de usuários usando o endpoint de métricas:

Num active users from metrics

docker exec sharelatex curl http://127.0.0.1:3000/metrics | grep num_active_users
# # HELP num_active_users num_active_users
# # TYPE num_active_users gauge
# num_active_users{app="web-api",host="b3ae4ff549d8"} 16

Número total de usuários ativos (exemplo: usuários ativos nos últimos 365 dias):

Total number of active users

echo 'db.users.countDocuments({ lastActive: { $gte: new Date(new Date().getTime() - (365 * 24 * 60 * 60 * 1000)) } })' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 10

Atualizar as informações da conta de usuário

A forma de atualizar as contas depende de o SSO estar ativado ou não.

Se o SSO não for usado:
- Os administradores podem modificar as informações da conta de usuário em Admin -> Manage Users (e-mail, nome, sobrenome e gerar um link de redefinição de senha).
- Os usuários comuns podem atualizar os seus próprios dados em Account -> Account Settings (incluindo alterar a senha e gerar tokens de autenticação do Git).
Se o SSO for usado:
- O Server Pro pode ser configurado para atualizar o nome e o sobrenome de um usuário durante o login com base no sistema de autenticação.
- Quando OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN ou OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN estão definidos como true, o formulário de dados do usuário em https://your-instance-url/user/settings fica desativado e o nome/sobrenome só podem ser definidos no seu sistema de gerenciamento de identidades.

Para mais detalhes, consulte:

Configuração do SAML 2.0: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0
Configuração do LDAP: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap

Última atualização há 4 meses Esta página de documentação contém links para guias e páginas de configuração externos. Todos os links e parâmetros de consulta são preservados como no conteúdo original.

Visão geral

Instalação

Configuração

Manutenção