prepare-raspbian-sd permet d’initialiser une SD pour votre Raspberry, entre autres, avec Raspbian ou Raspbian lite, puis dans un second temps d’y ajouter une configuration personnalisée et donc de faire le premier démarrage de votre Raspberry avec une pré-configuration adaptée à vos besoins.

prepare-raspbian-sd permet également d’installer des images dont vous connaissez l’URL ou même de créer une image à partir d’une carte SD.

Cet outil est principalement conçu pour les personnes qui ont de nombreux Raspberry Pis et qui souhaitent ensuite reconstruire avec un processus automatisé.

• Les versions près à l’emploi,
• La dernière release au moment de la publication de ce billet.
• Le code source (en anglais)

Initialisez vos cartes SD pour vos Raspberry PI

Les prérequis :

• Une machine sous GNU Linux (entièrement testé sous Linux Mint, et devrait fonctionner sans problème sur les Linux basés sur Ubuntu ou Debian),
• La commande git si vous souhaitez partir du code source,
• Un environnement bash 4 complet,
• Une paire de clés ssh correctement initialisé, si vous souhaitez préconfigurer votre clé publique pour accéder à votre PI en ssh sans mot de passe dès le premier démarrage.

Ce que fait l’outil :

• Télécharge la dernière version de l’image Raspbian ou Raspbian lite si nécessaire,
• Télécharge une image à partir de son URL (n’est pas limité aux Raspberry PI) ,
• Initialise la carte SD,
• Personnalise la carte SD (facultatif) :
  • Définir le partage de la mémoire (Configuration à l’aide GPU_MEM)
  • Prépare l’espace de travail BCM (facultatif),
  • Active ssh au démarrage du PI (facultatif),
  • Créer le premier utilisateur (différent de l’utilisateur pi)(facultatif),
  • Ajoutez des clés publiques (<INITIAL_USER_HOME>/.ssh/authorized_keys) (facultatif),
• Sauvegarde le contenu d’une carte SD dans un fichier image.

Installation :

Installation depuis la dernière « release »

Depuis un terminal :

wget https://www.cclaude.rocks/releases/prepare-raspbian-sd/prepare-raspbian-sd-v2023-02-24.tar.gz &&
tar -zxf prepare-raspbian-sd-v2023-02-24.tar.gz &&
cd prepare-raspbian-sd/ &&
sudo ./prepare-raspbian-sd-install.sh

Installation depuis le code source

• L’installation depuis le code source implique de maîtriser de git

  Ce projet utilise des sous-modules git, il est donc nécessaire de les prendre en compte :

  Comment cloner le référentiel. Étant donné que ce référentiel utilise des sous-modules git, vous devez utiliser le paramètre --recurse-submodules à la commande git clone. Ensuite utilisez la commande prepare-raspbian-sd-install.

  # cd "${home}/Sources" # Adapter à votre guise.
  git clone --recurse-submodules https://git.cclaude.rocks/raspberry/prepare-raspbian-sd.git
  cd prepare-raspbian-sd
  sudo bash prepare-raspbian-sd-install.sh
  

  Mise à jour depuis le code source

  Ce projet utilise des sous-modules git. Lors d’une mise-à-jour vous devez également initialiser les sous-modules (cas d’ajout d’un nouveau modules) et les mettre à jour :

  git fetch --verbose --prune # Mise à jour des références git
  git pull --ff-only          # Mise à jour de la branche courante (si nécessaire)
                              # Ne fusionnez pas avec vos modifications (le cas échéant)
  git submodule init          # Initialiser des sous-modules git (si nécessaire)
  git submodule update        # Mettre à jour des sous-modules git (si nécessaire)
  git status                  # Affiche de l’état actuel
  

  Exécutez ensuite à nouveau prepare-raspbian-sd-install.sh pour mettre à niveau votre installation.

  sudo bash prepare-raspbian-sd-install.sh
  

Désinstallation

Dour désinstaller l’application, vous devez utiliser :

sudo bash /usr/local/share/prepare-raspbian-sd/prepare-raspbian-sd-remove

Utilisation

L’aide :

• Aide en français

  prepare-raspbian-sd --help
  prepare-raspbian-sd ACTION [OPTIONS]…
  
  Actions :
    -h, --help                Affiche le message d’aide et quitte.
    -I, --put-image FILE      Initialise la carte SD à l’aide du fichier image FILE.
    -D, --put-default-image   Initialise la carte SD en utilisant l’image définie
                              par RASPBIAN_DEFAULT_IMG.
    -L, --put-last-image      Initialise la carte SD en utilisant la dernière
                              version disponible de l’image Raspbian. Télécharge
                              l’image à partir du site Web de Raspbian si
                              nécessaire.
        --configure           Appliquer la configuration de l’utilisateur sur la
                              carte SD.
    -F, --full-clone          Créer une image de la carte SD dans le répertoire
                              défini par RASPBIAN_DEFAULT_BACKUP_DIRECTORY (un nom
                              de fichier sera généré à partir de la date).
    -T, --full-clone-to FILE  Créer une image de la carte SD dans le fichier FILE.
        --compute-sd-dev-name Localise la carte SD et affiche le nom des
                              périphériques associés, puis quitte.
  
  Options :
    --arch ARCH           Défini le type de processeur de la machine (optionnel).
                            --arch '' : Télécharge et installe la version Raspbian
                            --arch armhf : Télécharge et installe la version 32 bits de « Raspberry Pi OS »
                            --arch arm32 : Identique à 'armhf'
                            --arch arm64 : Télécharge et installe la version 64 bits de "Raspberry Pi OS"
    --auto-umount         Démontage automatique de la carte SD (Attention essayez d'abord en ajoutant --dry-run la première fois)
    --debug               Affiche des messages supplémentaires
    --desktop             Alias pour --full
    --dev-name DEVNAME    Force le nom du périphérique à utiliser pour la carte SD.
    --download-to DIR     Téléchargez une nouvelle image si nécessaire dans le
                          Répertoire donné. Si la valeur de l’option est omise la
                          valeur définie par RASPBIAN_DEFAULT_DOWNLOAD_IMAGE_DIRECTORY
                          sera utilisée.
    --dry-run             Affiche le nom des périphériques associés à la carte SD, puis quitte.
    --expected-img IMG    Nom de fichier d’image attendu (sans chemin). Obligatoire avec action --url
                          permet de ne pas télécharger le fichier distant si un fichier local est présent.
    --full                Téléchargez la version de bureau au lieu de la
                          version allégée (version serveur).
    --gui                 Alias pour --full (obsolète)
    --unzip               Unzip le fichier après le téléchargement, et utilise le fichier 'unzippé' comme fichier image.
                          (gzip et unzip sont supportés)
  
  

  Sécurité :

  Pour écrire sur SD (à l’exception de l’action --configure), l’outil vérifie que la carte SD n’est PAS monté. Soit à l’aide de la commande umount, soit à l’aide de l’interface graphique, soit en utilisant avec prudence le paramètre --auto-umount

L’usage typique consiste à mettre une image sur la carte SD, dans le cas de Raspberry Pi OS 64 bits en mode serveur (sans interface graphique), on fera :

prepare-raspbian-sd -L --arm64

Ensuite si vous souhaitez customiser la carte, utilisez :

prepare-raspbian-sd --configure # Nécessite que vous ayez paramétré votre configuration

Configuration

En option, vous pouvez utiliser prepare-raspbian-sd pour personnaliser la SD.

Vous avez deux options pour personnaliser le répertoire de téléchargement par défaut, qui est l’emplacement où les images seront stockées. Vous pouvez d’abord utiliser prepare-raspbian-sd-config par exemple :

_DOWNLOAD_="$( xdg-user-dir DOCUMENTS )/raspbian-images/download" # Défini le répertoire qui recevra les images téléchargées
_BACKUP_="$( xdg-user-dir DOCUMENTS )/raspbian-images/backups"    # Défini le répertoire qui recevra les sauvegardes de vos SD

# Créer les répertoires (si nécessaire)
mkdir -vp "${_DOWNLOAD_}" "${_BACKUP_}"

# Configuration (optionnel, mais recommandé)
prepare-raspbian-sd-config RASPBIAN_DEFAULT_BACKUP_DIRECTORY "${_BACKUP_}"
prepare-raspbian-sd-config RASPBIAN_DEFAULT_DOWNLOAD_IMAGE_DIRECTORY "${_DOWNLOAD_}"
prepare-raspbian-sd-config SSH_AUTHORIZED_KEYS "$( cat ~/.ssh/id_rsa.pub )"
prepare-raspbian-sd-config --set-boolean BCM_WORKSPACE true
prepare-raspbian-sd-config --set-boolean SSH_ENABLE true
prepare-raspbian-sd-config --set-boolean SSH_CONFIGURE true

Pour définir un utilisateur personnalisé, ajoutez :

prepare-raspbian-sd-config --set RASPBIAN_USER_NAME 'monutilisateur'
prepare-raspbian-sd-config --set RASPBIAN_USER_PASSWORD 'le mot de passe'

Configuration optionnelle : si vous utiliser ce code assurez-vous que cela soit adapté à vos besoins.

prepare-raspbian-sd-config DEFAULT_SD_DEV_NAME 'mmcblk0' # Facultatif plus
prepare-raspbian-sd-config --set-integer GPU_MEM '16' # Pour un serveur cela peut être pratique.
prepare-raspbian-sd-config RASPBIAN_DEFAULT_IMG "${_DOWNLOAD_}/2019-07-10-raspbian-buster-lite.img" # Très facultatif !

• Si la valeur RASPBIAN_DEFAULT_DOWNLOAD_IMAGE_DIRECTORY n’est pas définie, votre dossier Téléchargement sera utilisé.
• Si la valeur RASPBIAN_DEFAULT_BACKUP_DIRECTORY n’est pas définie, votre dossier Documents sera utilisé.

Résumé :

La prise en charge de la création d’un utilisateur durant la séquence de démarrage initiale, il y a quelques modifications :

• RASPBIAN_PI_GROUP_ID n’est plus pris en compte, utilisez RASPBIAN_USER_GROUP_ID à la place,
• RASPBIAN_PI_USER_ID n’est plus pris en compte, utilisez RASPBIAN_USER_ID à la place.

Cas concret d’utilisations

Initialisation de votre carte SD

Pour télécharger (si nécessaire) la dernière version de Raspbian, puis initialiser votre carte SD :

prepare-raspbian-sd -L --arch armhf # Pour Raspberry PI « inférieur » au PI4

ou

prepare-raspbian-sd -L --arch arm64 # Pour un Raspberry PI 4

Sauvegarde de votre carte SD

Pour sauvegarder l’image complète de votre carte SD (toutes les partitions seront sauvegardées dans le même fichier), il suffit d’utiliser la syntaxe suivante :

prepare-raspbian-sd -T "${HOME}/ma-carte-sd.img'

ᦿ