Documentation URL hackademy plus formel

hackademy/url.mdwn

@@ -1,41 +1,83 @@
 # Paramètres URL
 
-Hackademy Linux accepte de recevoir des paramètres dans son URL, comme par exemple :
+Hackademy Linux - Paramètres d'URL pour la configuration de la machine virtuelle
 
-[https://linux.hackade.org/?disk=normal&autologin=user&autostart=true](https://linux.hackade.org/?disk=normal&autologin=user&autostart=true)
+## Synopsis
 
-## Sélection de l'image
+```
+https://linux.hackade.org/?[OPTION]=[VALEUR]&[OPTION]=[VALEUR]...
+```
 
-La sélection de l'image se fait avec le paramètre __disk__. Les images disponibles sont :
+## Description
 
-* core
-* server 
-* practice (valeur par défaut)
-* play
+Hackademy Linux accepte des paramètres dans son URL pour configurer le comportement de la machine virtuelle au lancement.
 
-## Login automatique
+Exemple :
 
-Le paramètre __autoLogin__ permet de se connecter directement à la machine virtuelle au lancement. Trois options sont possibles : rien, user ou root. Par défaut l'autologin n'est pas activé.
+```
+https://linux.hackade.org/?disk=practice&autologin=user&autostart=true
+```
 
-## Démarrage automatique
+## Options
 
-Le paramètre __autostart__ permet d'indiquer si au chargement de la page, la machine virtuelle doit démarrer. Par défaut le démarrage est automatique.
+### disk
 
-## Script d'initialisation personnalisé
+Sélectionne l'image système à utiliser pour la machine virtuelle.
 
-Le paramètre __custom_init__ permet de passer un script qui sera exécuté en root lors de la séquence de démarrage.
+**Valeurs possibles :**
 
-Le paramètre doit être encoder en base64url.
+- `core` - Image minimale
+- `server` - Image serveur
+- `practice` - Image d’entraînement (par défaut)
+- `play` - Image de jeu
 
-Pour encoder et décoder votre script, vous pouvez utiliser les commandes `base64url_encode` et `base64url_decode` au sein de Hackademy Linux, ou utiliser la commande suivante :
+**Valeur par défaut :** `practice`
+
+### autologin
+
+Active la connexion automatique à la machine virtuelle au lancement.
+
+**Valeurs possibles :**
+
+- (vide) - Pas de connexion automatique
+- `user` - Connexion en tant qu'utilisateur standard
+- `root` - Connexion en tant qu'utilisateur root
+
+**Valeur par défaut :** Désactivé
+
+### autostart
+
+Détermine si la machine virtuelle démarre automatiquement au chargement de la page.
+
+**Valeurs possibles :**
+
+- `true` - Démarrage automatique
+- `false` - Démarrage manuel
+
+**Valeur par défaut :** `true`
+
+### custom_init
+
+Spécifie un script personnalisé qui sera exécuté en tant que root lors de la séquence de démarrage.
+
+**Format :** Le script doit être encodé en base64url.
+
+**Comportement :**
+
+- Lorsque ce paramètre est défini, `autostart` est automatiquement désactivé
+- Un message affiche le code dans la console avant le démarrage
+
+**Encodage du script :**
+
+Pour encoder votre script, utilisez les commandes `base64url_encode` et `base64url_decode` au sein de Hackademy Linux, ou la commande suivante :
 
 ```sh
 cat init_script.sh | base64 -w0 | tr '+/' '-_' | tr -d '='
 ```
 
-Lorsque __custom_init__ est paramétré, __autostart__ est automatiquement désactivé et un message affiche le code dans la console avant le démarrage.
+**Exemple :**
 
-Exemple avec le script suivant:
+Script d'origine :
 
 ```sh
 #!/bin/sh -l
@@ -44,18 +86,29 @@ echo "Here's an example of the custom_init functionality."
 opkg update && opkg install tmux
 ```
 
-[https://linux.hackade.org/?custom_init=IyEvYmluL3NoCgplY2hvI...](https://linux.hackade.org/?custom_init=IyEvYmluL3NoIC1sCmVjaG8gIkhlcmUncyBhbiBleGFtcGxlIG9mIHRoZSBjdXN0b21faW5pdCBmdW5jdGlvbmFsaXR5LiIKb3BrZyB1cGRhdGUgJiYgb3BrZyBpbnN0YWxsIHRtdXgK)
-
-## Persistance des données
-
-Le paramètre __persistence__ permet de monter un disque dans la VM dont le contenu sera stocké dans le navigateur. Ces données persistent au redémarrage de la VM, tant que les données d'applications ne sont pas effacées de l'historique du navigateur.
-
-Ce disque est **/dev/sdb**, il est monté automatiquement dans **/data** quand le paramètre est actif.
-
-Pour être sûr qu'aucune donnée ne se perde, il est conseillé de synchroniser les données avant d'arrêter Hackademy avec la commande suivante:
+URL :
 
 ```
+https://linux.hackade.org/?custom_init=IyEvYmluL3NoIC1sCmVjaG8gIkhlcmUncyBhbiBleGFtcGxlIG9mIHRoZSBjdXN0b21faW5pdCBmdW5jdGlvbmFsaXR5LiIKb3BrZyB1cGRhdGUgJiYgb3BrZyBpbnN0YWxsIHRtdXgK
+```
+
+### persistence
+
+Active le montage d'un disque persistant dont le contenu est stocké dans le navigateur.
+
+**Comportement :**
+
+- Crée un périphérique `/dev/sdb`
+- Monté automatiquement dans `/data`
+- Les données persistent au redémarrage de la VM
+- Les données sont conservées tant que l'historique du navigateur n'est pas effacé
+
+**Synchronisation des données :**
+
+Pour éviter toute perte de données, synchronisez le système de fichiers avant d'arrêter Hackademy :
+
+```sh
 sync
 ```
 
-Par défaut, le disque persistant n'est pas instancié.
+**Valeur par défaut :** Désactivé