Setup Wizard

À quoi sert cet écran

L’assistant de mise en place définit les étapes qu’une personne doit exécuter localement avant que l’application ne fonctionne sur sa machine : cloner des dépôts, ajouter des entrées hosts, lancer des scripts d’initialisation ou fournir des valeurs propres à son environnement.

Il ne fait pas partie du déploiement. C’est le README que vous écririez sans que personne ne le suive.

Avant de commencer

Ouvrir l’écran

L’onglet Setup Wizard dans la barre d’onglets.

L’onglet Setup Wizard permet de configurer une expérience de configuration guidée pour les développeurs qui exécuteront votre application localement via le Fenwave Agent CLI. Il standardise la configuration de l’environnement de développement local au sein de votre équipe.

📸 Capture d’ecran : L’onglet Setup Wizard avec une tâche définie. Repères : (1) le contrôle d’activation, (2) le réglage Allow Skip, (3) une tâche et son type, (4) la section des variables.

Vue d’ensemble

Utilisez le Setup Wizard lorsque votre application nécessite des étapes de configuration locale spécifiques — clonage de repos, ajout d’entrées hosts, exécution de scripts d’initialisation ou collecte de valeurs spécifiques à l’environnement.

Accédez-y en cliquant sur l’onglet “Setup Wizard” dans la barre d’onglets.

Activation du Wizard

Basculez “Enable Local Setup Wizard for this application” sur ON. L’assistant s’exécute automatiquement lors de la première configuration locale de l’application.

Setup Notes

Fournissez des instructions ou des prérequis que les développeurs verront avant de démarrer l’assistant (ex. outils requis, ports disponibles, identifiants à préparer).

Allow Skip

Permet aux développeurs de sauter l’assistant entier. Activez pour les utilisateurs expérimentés ou les configurations simples ; désactivez quand des étapes spécifiques sont obligatoires.

Setup Tasks

Les tâches sont les étapes individuelles que les développeurs exécuteront pendant l’assistant. Elles s’exécutent dans l’ordre de haut en bas.

Types de tâches disponibles

Configuration des tâches

Toutes les tâches partagent un Title (requis) et une Description (optionnel). Champs spécifiques par type :

Git Clone : Repository URL (requis), Branch (optionnel)

Hosts Entry : Hostname (requis), IP Address (optionnel, par défaut 127.0.0.1)

File Copy : Source Path, Destination Path (requis), Template Content (supporte la substitution ``)

File Edit : Source Path (requis), Destination Path (requis)

Command : Command (requis), Working Directory (optionnel)

Input : Input Label (requis), Placeholder, Validation Pattern (regex)

Checkbox : Checkbox Label (requis)

Path Select : Path Label (requis), Must Contain (liste de fichiers séparés par des virgules)

SSL Certificate : Domains (requis, séparés par des virgules), Cert Name (optionnel), Install CA (par défaut : true). Nécessite mkcert. Génère trois variables de sortie : ,, ``.

Gestion des tâches

• Réordonner : Utilisez les flèches haut/bas sur chaque ligne de tâche
• Modifier : Cliquez sur l’icône d’édition, puis sauvegardez
• Supprimer : Cliquez sur l’icône de suppression

Variables

Les tâches peuvent définir et consommer des variables pour passer des données entre les étapes.

Définition des variables

Définissez un nom de Output Variable sur n’importe quelle tâche. Lors de l’exécution de l’assistant, le résultat de la tâche est stocké dans cette variable :

• Tâches Input → valeur saisie par l’utilisateur
• Tâches Git Clone → chemin du dépôt cloné
• Tâches Path Select → chemin du répertoire sélectionné
• Tâches SSL Certificate → trois chemins (cert, key, CA)

Utilisation des variables

Référencez les variables dans les tâches suivantes avec `` :

git clone https://@github.com/org/repo.git

Le panneau Setup Wizard affiche une section “Available Variables” listant toutes les variables définies.

Validation

Les variables doivent être définies par une tâche qui s’exécute avant la tâche qui les utilise. Les références non définies déclenchent un avertissement indiquant la tâche et la variable concernées.

Bonnes pratiques

Ordre de tâches recommandé :

1. Checkbox — Confirmer les prérequis (ex. Docker installé)
2. Input — Collecter les identifiants/tokens
3. Git Clone — Obtenir le code source
4. File Copy — Configurer les fichiers de configuration
5. Hosts Entry — Configurer les hostnames locaux
6. SSL Certificate — Générer les certificats (si nécessaire)
7. Command — Installer les dépendances et initialiser

Scénario

Les nouveaux arrivants échouent tous à la même étape locale.

1. Identifiez l’étape qui bloque. C’est généralement une entrée hosts ou un script que l’auteur d’origine a oublié depuis longtemps avoir exécuté.
2. Ouvrez l’onglet Setup Wizard et activez-le.
3. Ajoutez cette étape comme tâche du bon type, avec une description claire. La description est lue par quelqu’un qui ignore encore ce que fait l’application : écrivez pour cette personne, pas pour vous.
4. Lorsque l’étape exige une valeur propre à chacun, définissez une variable plutôt que de coder la vôtre en dur. Ajoutez une validation pour qu’une mauvaise valeur soit détectée à la saisie et non trois étapes plus loin.
5. Décidez délibérément de l’option Allow Skip. Une étape obligatoire mais sautable sera sautée.
6. Faites exécuter l’assistant par le prochain arrivant et observez sans aider. Chaque hésitation signale une description à retravailler.

En cas de problème

Pour aller plus loin

• Gestion des applications — publier ce que vous avez construit