Aller au contenu

Créer un compte utilisateur en ligne de commande

Vous administrez une instance Kirexo et vous voulez créer le premier compte administrateur, ou un compte (utilisateur, admin ou mixte) sans passer par l'interface.

L'inscription publique est fermée dans Kirexo. La commande app:user:create sert avant tout à amorcer le premier administrateur d'une instance : c'est lui qui ouvre ensuite l'espace admin et invite les autres personnes.

Le chemin courant est l'invitation

Une fois un administrateur en place, ajoutez les comptes par invitation depuis l'espace admin : la personne invitée choisit elle-même son prénom et son mot de passe, et aucun accès au serveur n'est nécessaire. Voir Gérer les comptes utilisateurs.

L'interface d'admin gère les comptes mais jamais le contenu (cf. Architecture).

Prérequis

  • Une instance démarrée : sur une instance installée, docker compose ps affiche (healthy) pour le service php. L'installation complète, création du premier compte comprise, est décrite pas à pas dans Installer Kirexo chez soi.
  • Pour la saisie masquée du mot de passe, un terminal interactif (la fenêtre où vous tapez vos commandes, par exemple une session SSH). Sans terminal (script de provisionnement), le mot de passe est lu sur l'entrée standard, avec -T obligatoire : voir Sans terminal.

Sur une instance installée

Depuis le répertoire d'installation (par exemple /opt/kirexo), remplacez VOTRE_EMAIL par l'adresse e-mail du compte et VOTRE_PRENOM par le prénom de son titulaire :

docker compose exec -it php bin/console app:user:create VOTRE_EMAIL VOTRE_PRENOM --role=both

docker compose exec -it php lance la commande dans le service php de Kirexo, en lui donnant accès à votre terminal. L'option --role choisit le rôle du compte (user, admin ou both, détaillés dans Arguments et option).

La commande demande ensuite le mot de passe en mode masqué, puis une seconde fois pour le confirmer : rien ne s'affiche pendant la saisie, c'est normal.

 Mot de passe:
 >

 Confirmez le mot de passe:
 >

Le mot de passe n'est jamais passé en argument : il resterait sinon dans l'historique du shell. La commande ne refuse qu'un mot de passe vide ; choisissez-en tout de même un d'au moins 8 caractères, la règle appliquée aux comptes créés par invitation. Dans un terminal, il est demandé deux fois : si les deux saisies diffèrent, la commande répond « Les deux saisies du mot de passe diffèrent : aucun compte n'a été créé. Relancez la commande. » et ne crée rien. Sans terminal, il est lu une seule fois sur l'entrée standard : voir Sans terminal.

Résultat attendu : une ligne [OK] ✓ Utilisateur créé : …, qui rappelle l'e-mail, les rôles attribués et l'identifiant du compte. La commande se termine avec le code de sortie 0. Si vous avez laissé VOTRE_EMAIL tel quel, elle répond « Email invalide » et ne crée rien.

Pour une autre personne, sans SMTP

L'invitation passe par un e-mail : elle demande un serveur d'envoi d'e-mails (SMTP) fonctionnel. S'il est indisponible, la même commande crée directement le compte d'une autre personne. Remplacez EMAIL_DU_COMPTE par son adresse et PRENOM_DU_COMPTE par son prénom :

docker compose exec -it php bin/console app:user:create EMAIL_DU_COMPTE PRENOM_DU_COMPTE --role=user

Vous choisissez alors son mot de passe à sa place : transmettez-le-lui par un canal sûr. C'est une voie de secours : l'invitation reste la voie normale, parce qu'elle laisse la personne choisir elle-même son mot de passe.

Sans terminal

Dans un script de provisionnement (une installation automatisée, sans personne devant le terminal), le mot de passe est lu une seule fois sur l'entrée standard, sans confirmation. -T remplace alors -it et il est obligatoire : il indique à Docker Compose qu'aucun terminal n'est attaché.

Dans la commande ci-dessous, $MOT_DE_PASSE est une variable du shell de votre script, qui contient le mot de passe du compte. Remplacez aussi VOTRE_EMAIL et VOTRE_PRENOM :

printf '%s\n' "$MOT_DE_PASSE" | docker compose exec -T php bin/console app:user:create VOTRE_EMAIL VOTRE_PRENOM --role=admin

Le mot de passe vient d'un secret

En provisionnement automatisé, le mot de passe passé sur l'entrée standard doit venir d'un secret, jamais d'une valeur écrite dans le script : le compte créé peut être administrateur. Lisez MOT_DE_PASSE depuis un fichier lisible par vous seul ou depuis un gestionnaire de secrets.

Arguments et option

Élément Obligatoire Défaut Description
email (argument) oui — Email du compte. Validé : non vide et format email correct.
firstName (argument) oui — Prénom du titulaire. Non vide. Placé après l'email. Nomme le carnet par défaut créé avec le compte.
--role (option) non user Rôle du compte : user, admin ou both.

Carnet par défaut

À la création, la commande crée le compte et son premier carnet dans la même unité de travail. Le carnet reçoit un nom dérivé du prénom : « Le carnet de PRENOM », où PRENOM est le prénom passé à la commande. Par exemple, app:user:create alice@example.org Alice crée un compte doté d'un carnet nommé « Le carnet de Alice ».

Ce nom n'est qu'un défaut : il reste librement modifiable ensuite par l'utilisateur, qui peut aussi créer d'autres carnets. Tout compte possède ainsi au moins un carnet dès sa création. Sur le modèle de données multi-carnets, voir Carnets : modèle de données et migration mono → multi-carnets.

Cas d'erreur

La commande s'arrête avec le code de sortie 1 et un message explicite dans les situations suivantes :

Situation Message
--role hors user / admin / both Rôle invalide, avec la liste des valeurs acceptées.
Email vide L'email ne peut pas être vide.
Prénom vide Le prénom ne peut pas être vide.
Email mal formé Email invalide, avec la raison renvoyée par le validateur.
Email déjà utilisé Un compte existe déjà avec cet email.
Mot de passe vide Le mot de passe ne peut pas être vide.
Confirmation différente du mot de passe (dans un terminal) Les deux saisies du mot de passe diffèrent : aucun compte n'a été créé. Relancez la commande.

Aucun compte n'est créé tant qu'une de ces conditions échoue.

Pour le mainteneur et les développeurs

Cette section ne concerne pas une instance installée avec le bundle.

Sur la stack de développement

Prérequis : la stack Docker du dépôt démarrée (castor docker:up) et les migrations à jour (castor doctrine:migrate).

La commande n'a pas de cible Castor dédiée : elle passe par la cible générique castor console, qui exécute bin/console dans le conteneur php.

Depuis l'hôte :

castor console "app:user:create alice@example.org Alice --role=admin"

Si vous avez déjà un shell dans le conteneur php (castor docker:sh) :

bin/console app:user:create alice@example.org Alice --role=admin

Autres exemples, un compte utilisateur standard (rôle par défaut) puis un compte cumulant les deux rôles :

castor console "app:user:create bob@example.org Bob"
castor console "app:user:create carlos@example.org Carlos --role=both"

Sous le capot

La commande est implémentée dans src/Command/AppUserCreateCommand.php. Elle :

  • résout --role avec l'enum App\Entity\Enum\AccountRole (src/Entity/Enum/AccountRole.php, AccountRole::tryFrom()), puis attribue les rôles de AccountRole::roles(). C'est le même enum que le formulaire d'invitation : un rôle both signifie la même chose en CLI et à l'invitation ;
  • valide l'email avec la contrainte Symfony\Component\Validator\Constraints\Email ;
  • vérifie l'unicité via UserRepositoryInterface::findByEmail() (src/Repository/UserRepositoryInterface.php) ;
  • demande le mot de passe par SymfonyStyle::askHidden(), qui le lit sur l'entrée standard quand aucun terminal n'est attaché ; si l'entrée standard est un terminal (stream_isatty(STDIN)), redemande une confirmation et échoue si elle diffère ;
  • hache le mot de passe avec UserPasswordHasherInterface ;
  • persiste le compte via UserRepositoryInterface::save() (sans flush immédiat) ;
  • construit un Notebook dont le nom est dérivé du prénom via Notebook::defaultName() (src/Entity/Notebook.php), puis le persiste via NotebookRepositoryInterface::save() (src/Repository/NotebookRepositoryInterface.php) — l'INSERT du compte précède celui du carnet, dont le propriétaire est non nul.

Correspondance --role → rôles stockés

La correspondance est portée par AccountRole::roles() :

--role Rôles attribués
user ROLE_USER
admin ROLE_ADMIN
both ROLE_USER, ROLE_ADMIN

Voir aussi