Gestion des utilisateurs

Créer un utilisateur administrateur

Déploiements avec l’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"

Déploiements avec l’ancien 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"

La commande crée un utilisateur avec l’adresse e-mail fournie s’il n’existe pas déjà, et en fait un administrateur. La sortie de la commande inclut une URL à visiter pour définir le mot de passe de cet utilisateur et se connecter pour la première fois.

Pour une approche automatisée, vous pouvez utiliser le même script pour créer des utilisateurs ordinaires comme des administrateurs. Pour les utilisateurs ordinaires, omettez l’option —admin.

Si vous utilisez des comptes internes pour l’authentification et devez promouvoir un utilisateur existant au rang d’administrateur de l’instance ou révoquer ses droits d’administrateur, procédez comme suit :

Via l'interface d'administration

Connectez-vous en tant qu’administrateur existant.
Cliquez sur Admin -> Manage Users.
Recherchez l’utilisateur et cliquez sur son adresse e-mail.
Faites défiler jusqu’à la section Site Admin et cliquez sur le lien (show).
Cochez la case Is Site Admin.
Cliquez sur Save pour terminer.

Supprimer des utilisateurs

Il est généralement conseillé de ne pas supprimer de comptes, sauf s’ils ne sont plus nécessaires. La suppression d’un compte retire le compte et fait perdre aux collaborateurs l’accès aux projets. Il n’existe actuellement aucun moyen de désactiver des comptes : ils existent avec leurs données conservées, ou ils sont supprimés. Par défaut, les comptes font l’objet d’une suppression logique (soft delete). Pour savoir comment supprimer définitivement des utilisateurs de votre instance, consultez ENABLE_CRON_RESOURCE_DELETION dans le guide des variables d’environnement.

Les comptes font l’objet d’une suppression logique par défaut. Consultez ENABLE_CRON_RESOURCE_DELETION pour le comportement de suppression définitive.

Via Admin -> Manage Users

Connectez-vous en tant qu’administrateur.
Cliquez sur Admin -> Manage Users.
Recherchez l’utilisateur et cochez la case à côté de son adresse e-mail.
Cliquez sur l’icône de corbeille.
Cliquez sur Delete pour confirmer.

Via la ligne de commande

Les comptes utilisateur (et leurs projets) peuvent être supprimés à l’aide des commandes suivantes. Déploiements avec l’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"

Déploiements avec l’ancien 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"

Le script de suppression utilise une option de forçage codée en dur qui garantit que la suppression a lieu même si l’e-mail de suppression de compte ne peut pas être envoyé (par exemple, lorsque l’adresse e-mail de l’utilisateur n’est plus en service).

Depuis la version 5.5.0, l’option —skip-email permet de ne pas envoyer d’e-mail d’information à l’utilisateur supprimé.

Restaurer un utilisateur supprimé logiquement

Si un utilisateur n’a fait l’objet que d’une suppression logique, vous pouvez restaurer son compte et ses projets.

Connectez-vous en tant qu’administrateur.
Cliquez sur Admin -> Manage Users.
Recherchez l’utilisateur que vous souhaitez restaurer.
Cliquez sur le bouton Display deleted users.
Cliquez sur l’adresse e-mail de l’utilisateur supprimé.
Cliquez sur Recover This Account.
Cliquez sur Recover pour confirmer.

Lorsque ENABLE_CRON_RESOURCE_DELETION est défini à true, les comptes supprimés logiquement peuvent être restaurés dans un délai de 90 jours. Passé ce délai, la récupération du compte n’est plus possible.

Compter les utilisateurs

Vous pouvez obtenir le nombre d’utilisateurs via l’interface d’administration à l’adresse https://you-instance-url/admin/user#license. Pour des vérifications et des exports automatisés, les exemples suivants peuvent vous aider. Nombre total d’utilisateurs :

Total number of users

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

Nombre total d’utilisateurs via le point de terminaison des métriques :

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

Nombre total d’utilisateurs actifs (exemple : utilisateurs actifs au cours des 365 derniers jours) :

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

Mettre à jour les informations d’un compte utilisateur

La manière de mettre à jour un compte dépend de l’activation ou non du SSO.

Si le SSO n’est pas utilisé :
- Les administrateurs peuvent modifier les informations d’un compte utilisateur via Admin -> Manage Users (e-mail, prénom, nom, et génération d’un lien de réinitialisation du mot de passe).
- Les utilisateurs ordinaires peuvent mettre à jour leurs propres informations via Account -> Account Settings (y compris changer leur mot de passe et générer des jetons d’authentification Git).
Si le SSO est utilisé :
- Server Pro peut être configuré pour mettre à jour le prénom et le nom d’un utilisateur lors de la connexion, à partir du système d’authentification.
- Lorsque OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN ou OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN valent true, le formulaire des informations utilisateur sur https://your-instance-url/user/settings est désactivé, et le prénom et le nom ne peuvent être définis que dans votre système de gestion des identités.

Pour plus de détails, voir :

Configuration SAML 2.0 : https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0
Configuration LDAP : https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap

Dernière mise à jour il y a 4 mois Cette page de documentation contient des liens vers des guides et des pages de configuration externes. Tous les liens et paramètres de requête sont conservés tels qu’ils figurent dans le contenu d’origine.

Aperçu

Installation

Configuration

Maintenance