Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gitbls/sdm

Raspberry Pi SD Card Image Manager
https://github.com/gitbls/sdm

Last synced: 3 months ago
JSON representation

Raspberry Pi SD Card Image Manager

Awesome Lists containing this project

README 

        
# sdm

Raspberry Pi SSD/SD Card Image Manager



## Description



`sdm` provides a quick and easy way to build consistent, ready-to-go SSDs and/or SD cards for the Raspberry Pi. This command line management tool is especially useful if you:



* have multiple Raspberry Pi systems and you want them all to start from an identical and consistent set of installed software packages, configuration scripts and settings, etc.



* want to rebuild your Pi system in a consistent manner with all your favorite packages and customizations already installed. Every time.



* want to be nice to your future self and make it super-easy to build fresh, customized systems when that next release of RasPiOS comes out.



* want to do the above repeatedly and a LOT more quickly and easily.



What does *ready-to-go* mean? It means that every one of your systems is fully configured with Keyboard mapping, Locale, Timezone, and WiFi set up as you want, all of your personal customizations and all desired RasPiOS packages and updates installed.



In other words, all ready to work on your next project.



With `sdm` you'll spend a lot less time rebuilding SSDs/SD Cards, configuring your system, and installing packages, and more time on the things you really want to do with your Pi.



Have questions about sdm? Please don't hesitate to ask in the Issues section of this github. If you don't have a github account (so can't post an issue/question here), please feel free to email me at: [[email protected]](mailto:[email protected]).



If you find sdm useful, please consider starring it to help me understand how many people are using it. Thanks!



## Usage overview



### sdm Quick Start



Here's how to quickly and easily to create and customize an IMG file and burn it to an SD Card. It's assumed that there is an SD Card in /dev/sde.



**Throughout this document read "SD Card" as "SSD or SD Card".** sdm treats them equivalently.



## Install sdm

```sh

curl -L https://raw.githubusercontent.com/gitbls/sdm/master/EZsdmInstaller | bash

```



* sdm will download the files to /usr/local/sdm by default, and make a link for sdm in /usr/local/bin for ease of use.

* **If needed, download** the desired RasPiOS zipped IMG from the raspberrypi.org website and **unzip** or **unxz** it.

* Direct link to the downloads: [Raspberry Pi Downloads](https://downloads.raspberrypi.org//?C=M;O=D)

* Pick the latest (Bookworm) image in the *images* subfolder of **raspios_armhf** (32-bit), **raspios_lite_armhf** (32-bit), **raspios_arm64** (64-bit), or **raspios_lite_arm64** (64-bit), as appropriate. Bullseye images are in the folders **raspios_oldstable_lite_armhf** and **raspios_oldstable_armhf**.



## Customize the image with sdm

```sh

sudo sdm --customize --plugin user:"adduser=bls|password=mypassword" --plugin L10n:host --plugin disables:piwiz --expand-root --regen-ssh-host-keys --restart 2023-12-05-raspios-bookworm-arm64.img

```



sdm will make the following changes to your IMG file:

* Copy your **Localization settings** (Keymap, Locale, Timezone, and WiFi Country) from the system on which it's running (if running on RasPiOS, Debian, or a Debian derivative such as Mint or Ubuntu)

* Configure the system in the IMG file to have **SSH enabled**

* Creates the specified user with the given password and enables sudo for that user

* Do an `apt update` and `apt upgrade`

* Prevents piwiz from running (not needed) and regenerates SSH host keys after the system time has been synchronized during the first system boot



No additional packages are installed in this example, but as you'll see, it's a simple addition to the command line to install your list of packages.



## Burn the image onto the SD Card

```sh

sudo sdm --burn /dev/sde --hostname mypi1 --expand-root 2023-12-05-raspios-bookworm-arm64.img

```



## Boot and Go



Load the SD card into a Pi and power it up. The system will come up as it always does:



* **WILL NOT:** Resize the root file system and restarts automatically, thanks to the use of `--expand-root`, which expands the root file system on the SD Card after the burn completes.

* After the system starts it goes through a complete system startup, just as it always does on a fresh SD Card

* Toward the end of the boot process the sdm FirstBoot service runs (once). It takes other actions as needed to fulfill the requested configuration.

* When the system boot is fully complete (it can take a while on a large SD card!), the system automatically restarts again



When the system comes back up your Pi is all happy, ready to go, and configured with:



* **The latest RasPiOS updates installed** for all installed packages

* **User created** and password set for username and password of your choice and sudo enabled

* **Hostname** set to *mypi1*, or whatever you choose to use as the hostname

* **Keymap**, **Locale**, and **Timezone** configured the same as the system on which you are running sdm (easily changeable, of course)

* **SSH** enabled



You can review the output of the sdm first boot script on the newly-booted system with:

```sh

sudo journalctl -b -1 | grep FirstBoot

```



## Next steps



If you want to adopt sdm into your RasPiOS management tools, a great way to get started is to use the Official Getting Started With sdm script to quickly and easily learn how to customize an IMG.



The most important new user docs are: Command Details and Plugins.



## What else can sdm do?



Here are a few examples:



* **Install applications**  — Editors (emacs, vim, zile, etc), and any other packages (browsers, etc) you always install in a new system. Direct sdm to install apps using the `apps` plugin. See the apps plugin for details.



* **Install and configure VNC** — Have every system or only selected systems come up with VNC installed and configured, using either RealVNC on the console, or TightVNC or TigerVNC virtual desktops. Or a combination of RealVNC on the console AND virtual desktops. See the VNC plugin.



* **Install and configure an Access Point (hotspot)** — Install a customizable, fully operational hotspot in any of three modes: *local*, *routed*, or *bridged*. (NOTE: this is temporarily unavailable, but will be coming back soon).



* **Enable Pi-specific devices** — Easily enable camera, i2c, etc, via raspi-config automation. See raspiconfig plugin .



* **Personal customizations** — Have every system come up running with your own customizations such as your favorite .bashrc and any other files that you always want on your system. This can be done easily using the `copyfile` plugin or with a personal Plugin. See my personal plugin for an example.



* **Append Custom fstab file to /etc/fstab** — Automatically append your site-specific fstab entries to /etc/fstab. See system plugin for details.



* **systemd service configuration and management** — If there are services that you always enable or disable, you can easily configure them with sdm. See the description of the `service-disable` and `service-enable` arguments to the system plugin.



* **Other customizations** — Done through a simple batch script called a Plugin. sdm-plugin-example is a skeleton Plugin that you can copy, modify, and use. See Programming Plugins.



* **Burn SD Card Image for network distribution** — You can also burn a customized SD Card Image to distribute via a mechanism other than an actual SD Card, such as the Internet.



    The recipient can burn the SD Card using any one of a number of tools on Linux ([Installing Operating System Images](https://www.raspberrypi.org/documentation/installation/installing-images/)), Windows ([Installing Operating System Images Using Windows](https://www.raspberrypi.org/documentation/installation/installing-images/windows.md)), or MacOS ([Installing Operating System Images Using MacOS](https://www.raspberrypi.org/documentation/installation/installing-images/mac.md)).



* **Update an already-burned RasPiOS SD Card or SSD** — use the `--explore` command switch to nspawn into the SD Card or SSD. While in the nspawn you can take care of system management activities in a near-online manner, such as changing the password for an account, installing additional packages, etc.



    This can be VERY handy if you forget the password to your user account on your favorite SD Card, for instance. You can boot up a second SD Card, install sdm on it, and then use `sdm --explore` to update the account password on that favorite SD Card.



## Complete sdm Documentation



Need more details? You'll find complete details about sdm in the online documentation and plugin-specific documentation here.



You can watch sdm in action here It's an older video and doesn't use plugins, but will give you a good idea of how sdm works.



## Platform Support Notes



Several people have run into issues with using sdm on a Mac. Unless you are technical enough to sort out how to make it work, or care enough to permanently donate a Mac to the sdm project, sdm is not supported on the Mac.