mmdebstrap

https://manpages.debian.org/unstable/mmdebstrap/
Admin
mmdebstrap is a multi-mirror Debian chroot creation tool that uses apt to resolve dependencies from...
Tokens:27,475
Snippets:329
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Configure keyring options

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Examples of setting keyring paths for apt during the initial setup.

```bash
    --keyring=/etc/apt/trusted.gpg --keyring=/etc/apt/trusted.gpg.d
```

--------------------------------

### Execute Setup Hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Run arbitrary commands after initial setup but before package installation. This is useful for tasks like adding apt sources. The chroot directory is passed as the first argument ($1).

```bash
--setup-hook='echo "deb http..." > "$1"/etc/apt/sources.list.d/custom.list'
```

--------------------------------

### Create Busybox-based Chroot with Setup Hooks

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Example of using multiple --setup-hook commands to create a minimal busybox-based chroot, including setting up essential directories, symlinks, passwd, and group files.

```bash
--setup-hook='mkdir -p "$1/bin"'
--setup-hook='for p in awk cat chmod chown cp diff echo env grep less ln
    mkdir mount rm rmdir sed sh sleep sort touch uname mktemp; do
    ln -s busybox "$1/bin/$p"; done'
--setup-hook='echo root:x:0:0:root:/root:/bin/sh > "$1/etc/passwd"'
--setup-hook='printf "root:x:0:\nmail:x:8:\nutmp:x:43:\n" > "$1/etc/group"'
```

--------------------------------

### Create extlinux-based system with mmdebstrap

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Create a Debian system image using mmdebstrap for architectures supporting extlinux. This example includes custom user setup and hostname configuration, and uses guestfish to prepare the disk image.

```bash
$ mmdebstrap --variant=important --include=linux-image-amd64 \
    --customize-hook='chroot "$1" passwd --delete root' \
    --customize-hook='chroot "$1" useradd --home-dir /home/user --create-home user' \
    --customize-hook='chroot "$1" passwd --delete user' \
    --customize-hook='echo host > "$1/etc/hostname"' \
    --customize-hook='echo "127.0.0.1 localhost host" > "$1/etc/hosts"' \
    --customize-hook=/usr/share/autopkgtest/setup-commands/setup-testbed \
    unstable debian-unstable.tar
$ cat << END > extlinux.conf
> default linux
> timeout 0
> 
> label linux
> kernel /vmlinuz
> append initrd=/initrd.img root=/dev/vda1 rw console=ttyS0
> END
$ guestfish -N debian-unstable.img=disk:8G -- \
    part-disk /dev/sda mbr : \
    part-set-bootable /dev/sda 1 true : \
    mkfs ext4 /dev/sda1 : mount /dev/sda1 / : \
    tar-in debian-unstable.tar / xattrs:true : \
    upload /usr/lib/EXTLINUX/mbr.bin /boot/mbr.bin : \
    copy-file-to-device /boot/mbr.bin /dev/sda size:440 : \
    extlinux / : copy-in extlinux.conf / : sync : umount / : shutdown
$ qemu-img convert -O qcow2 debian-unstable.img debian-unstable.qcow2
```

--------------------------------

### Setup merged-/usr using debootstrap-method hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Use the '--hook-dir' option with '/usr/share/mmdebstrap/hooks/merged-usr' to set up merged-/usr using the debootstrap-method, which handles architecture-specific symlinks and installs the 'usr-is-merged' package.

```bash
--hook-dir=/usr/share/mmdebstrap/hooks/merged-usr
```

--------------------------------

### Configure apt options

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Examples of passing various configuration options to apt via the --aptopt flag.

```bash
    --aptopt='Acquire::Check-Valid-Until "false"'
    --aptopt='Apt::Key::gpgvcommand "/usr/libexec/mmdebstrap/gpgvnoexpkeysig"'
```

```bash
    --aptopt='Acquire::Languages { "environment"; "en"; }'
    --aptopt='Acquire::Languages "none"'
```

```bash
    --aptopt='Apt::Install-Recommends "true"'
```

```bash
    --aptopt='Acquire::http { Proxy "http://127.0.0.1:3142"; }'
```

```bash
    --aptopt='APT::Sandbox::User "root"'
```

```bash
    --aptopt='APT::Solver "aspcud"'
    --aptopt='APT::Solver::aspcud::Preferences
       "-count(solution,APT-Release:=/a=experimental/),-removed,-changed,-new"'
```

--------------------------------

### Add custom apt sources via setup-hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Demonstrates adding a custom apt source list file during the setup phase.

```bash
    --setup-hook='echo "deb http..." > "$1"/etc/apt/sources.list.d/custom.list'
```

--------------------------------

### Include Additional Packages with --include

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Specify a comma or whitespace-separated list of packages to be installed in addition to the default packages for the selected variant. Dependencies are also installed. This example shows various syntaxes for specifying packages, including version pinning and disabling package splitting.

```bash
--include="pkg1/stable pkg2=1.0 pkg3-"
    --include=pkg1/stable,pkg2=1.0,pkg3-,
    --incl=pkg1/stable --incl="pkg2=1.0 pkg3-" --incl=pkg2=1.0,pkg3-
```

```bash
--include="?or(?priority(required), ?priority(important))"
```

```bash
--include="./path/to/deb with spaces/and,commas/foo.deb"
```

--------------------------------

### mmdebstrap Ubuntu Chroot Example

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Example of creating an Ubuntu chroot on a Debian system. This demonstrates how mmdebstrap handles Ubuntu-specific keyring configurations.

```APIDOC
## mmdebstrap bionic ubuntu-bionic.tar

### Description
Creates a chroot environment for the 'bionic' Ubuntu release and saves it to 'ubuntu-bionic.tar'. If 'gpg' and 'ubuntu-archive-keyring' are installed, 'signed-by' will be automatically added to the sources.list.

### Method
Command Line Tool

### Endpoint
N/A (Local command execution)

### Parameters
#### Path Parameters
- **bionic** (string) - Required - The Ubuntu release codename (e.g., 'bionic').
- **ubuntu-bionic.tar** (string) - Required - The output filename for the chroot tarball.

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
mmdebstrap bionic ubuntu-bionic.tar
```

### Response
N/A (Creates a file)

```

--------------------------------

### Add a User Without a Password

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Execute arbitrary commands after chroot setup using --customize-hook. This example adds a user and then deletes their password.

```bash
--customize-hook='chroot "$1" useradd --home-dir /home/user
        --create-home user'
```

```bash
--customize-hook='chroot "$1" passwd --delete user'
```

--------------------------------

### Execute Extract Hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Run commands after essential packages are extracted but before they are installed. This example installs busybox symlinks within the chroot.

```bash
--extract-hook='chroot "$1" /bin/busybox --install -s'
```

--------------------------------

### Setup busybox-based chroot via setup-hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Configures a minimal busybox environment by creating necessary directories, symlinks, and basic passwd/group files.

```bash
    --setup-hook='mkdir -p "$1/bin"'
    --setup-hook='for p in awk cat chmod chown cp diff echo env grep less ln
        mkdir mount rm rmdir sed sh sleep sort touch uname mktemp; do
        ln -s busybox "$1/bin/$p"; done'
    --setup-hook='echo root:x:0:0:root:/root:/bin/sh > "$1"/etc/passwd'
    --setup-hook='printf "root:x:0:\nmail:x:8:\nutmp:x:43:\n" > "$1"/etc/group'
```

--------------------------------

### Create reproducible images from a timestamp

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap-autopkgtest-build-qemu.1.en.html

This example demonstrates creating bit-by-bit reproducible QEMU images by specifying a SOURCE_DATE_EPOCH and a mirror from a specific timestamp. Remember to include --boot=efi for both the image building and autopkgtest invocation.

```bash
SOURCE_DATE_EPOCH=1612543740 mmdebstrap-autopkgtest-build-qemu --boot=efi \
    --mirror=http://snapshot.debian.org/archive/debian/20210205T164900Z/ \
    unstable /path/to/debian-unstable.img
```

--------------------------------

### Common hook-directory configurations

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Examples of using pre-defined hook directories for common tasks.

```bash
    --hook-dir=/usr/share/mmdebstrap/hooks/eatmydata
```

```bash
    --hook-dir=/usr/share/mmdebstrap/hooks/busybox
```

```bash
    --hook-dir=/usr/share/mmdebstrap/hooks/file-mirror-automount
```

--------------------------------

### Run mmdebstrap in chrootless mode

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

This example demonstrates how to use mmdebstrap in chrootless mode, which installs packages without dpkg and apt inside the target. It requires careful handling to avoid unintended system changes.

```bash
mmdebstrap --variant=apt --include=mmdebstrap \
    --customize-hook='chroot "$1" mmdebstrap --mode=chrootless
                      --variant=apt unstable chrootless.tar' \
    --customize-hook='copy-out chrootless.tar .' unstable /dev/null

```

--------------------------------

### Optimize package installation

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Use dpkg options to exclude unnecessary files like locales or documentation to reduce image size.

```bash
$ mmdebstrap --variant=essential \
    --dpkgopt='path-exclude=/usr/share/man/*' \
    --dpkgopt='path-include=/usr/share/man/man[1-9]/*' \
    --dpkgopt='path-exclude=/usr/share/locale/*' \
    --dpkgopt='path-include=/usr/share/locale/locale.alias' \
    --dpkgopt='path-exclude=/usr/share/doc/*' \
    --dpkgopt='path-include=/usr/share/doc/*/copyright' \
    --dpkgopt='path-include=/usr/share/doc/*/changelog.Debian.*' \
    unstable debian-unstable.tar
```

--------------------------------

### Include Packages with --include

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Specify additional packages to install using comma or whitespace separated lists.

```bash
--include="pkg1/stable pkg2=1.0 pkg3-"
    --include=pkg1/stable,pkg2=1.0,pkg3-,,,
    --incl=pkg1/stable --incl="pkg2=1.0 pkg3-" --incl=pkg2=1.0,pkg3-
```

```bash
--include="?or(?priority(required), ?priority(important))"
    --include="./path/to/deb with spaces/and,commas/foo.deb"
```

--------------------------------

### Simulate Package Installation

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Use --simulate or --dry-run to check package dependency compatibility without downloading or installing packages. No hooks are executed with these options.

```bash
--simulate
```

```bash
--dry-run
```

--------------------------------

### Equivalent mmdebstrap variant configurations

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Examples showing how different mmdebstrap variants map to --include arguments.

```bash
    --variant=essential --include="apt"
```

```bash
    --variant=essential --include="apt,build-essential"
```

```bash
    --variant=essential --include="?priority(required)"
```

```bash
    --variant=essential --include="~prequired|~pimportant"
```

```bash
    --variant=essential --include="~prequired|~pimportant|~pstandard"
```

--------------------------------

### Invalid unshare mapping examples

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Examples of mapping configurations that do not function as intended for root user mapping.

```bash
$ unshare --map-root-user --map-auto ...            # or equavalient:
$ unshare --map-user=0 --map-group=0 --map-users=auto --map-groups=auto ...
```

--------------------------------

### Install busybox symlinks via extract-hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Uses the extract-hook to install busybox symlinks after essential packages are extracted.

```bash
    --extract-hook='chroot "$1" /bin/busybox --install -s'
```

--------------------------------

### --include Option

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Explains the --include option for specifying additional packages to install in the chroot, including advanced usage with APT patterns and local .deb files.

```APIDOC
## --include Option

### Description
Specifies a list of packages to be installed in addition to those required by the selected variant. This option supports various syntaxes for package selection, including version pinning, APT patterns, and local `.deb` files. It can be used multiple times, with packages being concatenated and duplicates removed.

### Method
Command Line Tool Option

### Endpoint
N/A

### Parameters
#### Query Parameters
- **--include** (string) - A comma or whitespace-separated list of packages to install. Supports APT syntax like `pkg/suite`, `pkg=version`, `pkg-`, and APT patterns. Arguments starting with `?`, `!`, `~`, `(`, `/`, `./`, or `../` are treated as single arguments (patterns or file paths) and are not split.

### Request Example
```bash
mmdebstrap --include="pkg1/stable pkg2=1.0 pkg3-"
mmdebstrap --include="?or(?priority(required), ?priority(important))"
mmdebstrap --include="./path/to/deb with spaces/and,commas/foo.deb"
mmdebstrap --include=pkg1 --include=pkg2=1.0
```

### Response
N/A

#### Success Response (Package Installation)
- **Packages** - The specified additional packages are installed within the chroot.
```

--------------------------------

### mmdebstrap Simulation Mode

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Options for testing package installation without modifying the system.

```APIDOC
## --simulate / --dry-run

### Description
Run apt-get with --simulate. Only the package cache is initialized but no binary packages are downloaded or installed. Useful to check dependency resolution.
```

--------------------------------

### Advanced mmdebstrap with Customization Hooks

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Demonstrates advanced usage with custom variants and setup/customize hooks. Use when specific setup or customization steps are required.

```bash
$ mmdebstrap --variant=custom --skip=update,tar-in/mknod \
    --setup-hook='tar-in chroot.tar /' \
    --customize-hook='chroot "$1" whoami' unstable /dev/null
```

--------------------------------

### Create a Chroot with Signed Repository

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Use the 'signed-by' option to specify the GPG key for repository signing. This is automatically added to sources.list if the key is not trusted. Requires 'gpg' to be installed.

```bash
mmdebstrap mysuite out.tar "deb [signed-by=/path/to/key.gpg] http://..."
```

```bash
mmdebstrap bionic ubuntu-bionic.tar
```

--------------------------------

### LXC mapping format example

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Representation of the ID mapping format used by lxc-usernsexec.

```text
0:$UID:1 + 1:$SUBUIDBASE:65535
```

--------------------------------

### Specify Apt Keyring for mmdebstrap

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Change the default keyring used by apt during initial setup. This option is primarily for users replacing debootstrap. It can accept a file or a directory.

```bash
--keyring=/etc/apt/trusted.gpg --keyring=/etc/apt/trusted.gpg.d
```

--------------------------------

### mmdebstrap --include Option

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

The --include option specifies additional packages to install in the chroot. It supports various syntaxes for package names, versions, and apt patterns, and can be used multiple times.

```APIDOC
## mmdebstrap --include

### Description
Installs additional packages into the chroot. Packages can be specified as a comma or whitespace-separated list. Dependencies are also installed. The behavior depends on the variant used (e.g., 'extract', 'custom'). Supports apt syntax like 'pkg/suite', 'pkg=version', and apt patterns. Can be specified multiple times.

### Method
Command Line Tool Option

### Endpoint
N/A (Local command execution)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
--include="pkg1/stable pkg2=1.0 pkg3-"
--include=pkg1/stable,pkg2=1.0,pkg3-
--incl=pkg1/stable --incl="pkg2=1.0 pkg3-" --incl=pkg2=1.0,pkg3-
--include="?or(?priority(required), ?priority(important))"
--include="./path/to/deb with spaces/and,commas/foo.deb"
```

### Response
N/A (Installs packages into the chroot)

```

--------------------------------

### Exclude Paths to Reduce Chroot Size with --dpkgopt

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Use the --dpkgopt option to pass arbitrary options to dpkg, which are permanently added to /etc/dpkg/dpkg.cfg.d/99mmdebstrap inside the chroot. This example shows how to exclude man pages, locales, and documentation.

```bash
--dpkgopt='path-exclude=/usr/share/man/*'
    --dpkgopt='path-include=/usr/share/man/man[1-9]/*'
    --dpkgopt='path-exclude=/usr/share/locale/*'
    --dpkgopt='path-include=/usr/share/locale/locale.alias'
    --dpkgopt='path-exclude=/usr/share/doc/*'
    --dpkgopt='path-include=/usr/share/doc/*/copyright'
    --dpkgopt='path-include=/usr/share/doc/*/changelog.Debian.*'
```

--------------------------------

### Create and Boot a Disk Image

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Use guestfish to partition and format a disk image, then boot it with QEMU.

```bash
$ guestfish -N debian-unstable.img=disk:2G -- \
    part-disk /dev/sda mbr : \
    part-set-bootable /dev/sda 1 true : \
    mkfs ext4 /dev/sda1 : \
    set-label /dev/sda1 rootfs : \
    mount /dev/sda1 / : \
    tar-in fs.tar / xattrs:true : \
    command "grub-install /dev/sda" : \
    command update-grub : \
    sync : umount / : shutdown
$ qemu-system-x86_64 -m 1G -enable-kvm debian-unstable.img
```

--------------------------------

### Execute Essential Hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Run commands after essential packages are installed but before remaining packages are installed. This hook is not executed for 'extract' and 'custom' variants. Example shows enabling unattended upgrades.

```bash
--essential-hook='echo unattended-upgrades'
```

--------------------------------

### Create bootable USB images

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Full workflow for creating a bootable Debian desktop image using customize-hooks, guestfish, and QEMU.

```bash
$ mmdebstrap --aptopt='Apt::Install-Recommends "true"' --customize-hook \
    'chroot "$1" adduser --comment user --disabled-password user' \
    --customize-hook='echo 'user:live' | chroot "$1" chpasswd' \
    --customize-hook='echo host > "$1/etc/hostname"' \
    --customize-hook='echo "127.0.0.1 localhost host" > "$1/etc/hosts"' \
    --include=linux-image-amd64,task-desktop unstable debian-unstable.tar
$ cat << END > extlinux.conf
> default linux
> timeout 0
>
> label linux
> kernel /vmlinuz
> append initrd=/initrd.img root=LABEL=rootfs
END
# You can use $(sudo blockdev --getsize64 /dev/sdXXX) to get the right
# image size for the target medium in bytes
$ guestfish -N debian-unstable.img=disk:8G -- \
    part-disk /dev/sda mbr : \
    part-set-bootable /dev/sda 1 true : \
    mkfs ext4 /dev/sda1 : \
    set-label /dev/sda1 rootfs : \
    mount /dev/sda1 / : \
    tar-in debian-unstable.tar / xattrs:true : \
    upload /usr/lib/EXTLINUX/mbr.bin /boot/mbr.bin : \
    copy-file-to-device /boot/mbr.bin /dev/sda size:440 : \
    extlinux / : copy-in extlinux.conf / : sync : umount / : shutdown
$ qemu-system-x86_64 -m 1G -enable-kvm debian-unstable.img
$ sudo dd if=debian-unstable.img of=/dev/sdXXX status=progress
```

--------------------------------

### Set Up /etc/hostname and /etc/hosts

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Customize the chroot environment by setting the hostname and hosts file using --customize-hook.

```bash
--customize-hook='echo host > "$1/etc/hostname"'
```

```bash
--customize-hook='echo "127.0.0.1 localhost host" > "$1/etc/hosts"'
```

--------------------------------

### Create Podman System

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Build a system image and import it into Podman.

```bash
$ mmdebstrap unstable | podman import - debian
[...]
$ podman run --network=none -it --rm debian whoami
root
```

--------------------------------

### Equivalence of hook-directory usage

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Demonstrates how --hook-directory expands into individual hook options.

```bash
    mmdebstrap --customize=./scriptA --hook-dir=./hooks --setup=./scriptB
```

```bash
    mmdebstrap --customize=./scriptA --setup=./hooks/setup01-foo.sh \
        --setup=./hooks/setup02-bar.sh --setup=./scriptB
```

--------------------------------

### Build Extlinux-bootable Image

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Create a custom image configured for extlinux booting on amd64 or i386 architectures.

```bash
$ mmdebstrap --variant=important --include=linux-image-amd64 \
    --customize-hook='chroot "$1" passwd --delete root' \
    --customize-hook='chroot "$1" useradd --home-dir /home/user --create-home user' \
    --customize-hook='chroot "$1" passwd --delete user' \
    --customize-hook='echo host > "$1/etc/hostname"' \
    --customize-hook='echo "127.0.0.1 localhost host" > "$1/etc/hosts"' \
    --customize-hook=/usr/share/autopkgtest/setup-commands/setup-testbed \
    unstable debian-unstable.tar
$ cat << END > extlinux.conf
> default linux
> timeout 0
>
> label linux
> kernel /vmlinuz
> append initrd=/initrd.img root=/dev/vda1 rw console=ttyS0
END
$ guestfish -N debian-unstable.img=disk:8G -- \
    part-disk /dev/sda mbr : \
    part-set-bootable /dev/sda 1 true : \
    mkfs ext4 /dev/sda1 : mount /dev/sda1 / : \
    tar-in debian-unstable.tar / xattrs:true : \
    upload /usr/lib/EXTLINUX/mbr.bin /boot/mbr.bin : \
    copy-file-to-device /boot/mbr.bin /dev/sda size:440 : \
    extlinux / : copy-in extlinux.conf / : sync : umount / : shutdown
$ qemu-img convert -O qcow2 debian-unstable.img debian-unstable.qcow2
```

--------------------------------

### Force chroot without merged-/usr using hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

To create a chroot without merged-/usr even after Debian 12 (Bookworm), use the '--hook-dir' option with '/usr/share/mmdebstrap/hooks/no-merged-usr'. This hook writes a message to '/etc/unsupported-skip-usrmerge-conversion' and installs 'usr-is-merged' to prevent 'usrmerge' installation.

```bash
--hook-dir=/usr/share/mmdebstrap/hooks/no-merged-usr
```

--------------------------------

### Create Docker System

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Build a system image and import it into Docker.

```bash
$ mmdebstrap unstable | sudo docker import - debian
[...]
$ sudo docker run -it --rm debian whoami
root
$ sudo docker rmi debian
```

--------------------------------

### Boot with GRUB2

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Alternative boot configuration for architectures lacking extlinux support.

```bash
$ mmdebstrap --include=linux-image-amd64,grub2,systemd-sysv unstable fs.tar
```

--------------------------------

### Create a basic chroot

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Create a chroot directory similar to debootstrap.

```bash
$ sudo mmdebstrap unstable ./unstable-chroot
```

--------------------------------

### Create and run a QEMU VM with debvm-create

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Use the debvm-create wrapper script to create a QEMU virtual machine for an arbitrary architecture. The VM can then be run with debvm-run.

```bash
$ debvm-create -r stable -- --architecture=riscv64
$ debvm-run
```

--------------------------------

### Manual mapping format example

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Representation of the ID mapping format when using --map-user=65536.

```text
0:$SUBUIDBASE:65536 + 65536:$UID:1
```

--------------------------------

### Automate VM creation with mmdebstrap-autopkgtest-build-qemu

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Use a wrapper script around mmdebstrap for creating virtual machines that support EFI booting. This is a replacement for autopkgtest-build-qemu and vmdb2 for multiple architectures.

```bash
$ mmdebstrap-autopkgtest-build-qemu unstable ./autopkgtest.img
```

--------------------------------

### Build QEMU image with amd64 architecture

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap-autopkgtest-build-qemu.1.en.html

Use this command to create a QEMU disk image for the amd64 architecture. Ensure the output path is accessible by the unshared user.

```bash
$ mmdebstrap-autopkgtest-build-qemu --boot=efi --arch=amd64 unstable /path/to/debian-unstable.img
    [...] 
    $ autopkgtest mypackage -- qemu --boot=efi --dpkg-architecture=amd64 /path/to/debian-unstable.img
```

--------------------------------

### Run mmdebstrap in chrootless mode

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Execute mmdebstrap in chrootless mode using customize hooks to install packages into a target without chrooting.

```bash
    mmdebstrap --variant=apt --include=mmdebstrap \
        --customize-hook='chroot "$1" mmdebstrap --mode=chrootless
                          --variant=apt unstable chrootless.tar' \
        --customize-hook='copy-out chrootless.tar .' unstable /dev/null
```

--------------------------------

### Build and test a QEMU image

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap-autopkgtest-build-qemu.1

Create a Debian unstable image and use it with autopkgtest. Ensure the output path is accessible to the unshared user.

```bash
$ mmdebstrap-autopkgtest-build-qemu --boot=efi --arch=amd64 unstable /path/to/debian-unstable.img
[...]
$ autopkgtest mypackage -- qemu --boot=efi --dpkg-architecture=amd64 /path/to/debian-unstable.img
```

--------------------------------

### Re-using Chroot Tarballs for Further Refinement

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Shows how to build upon an existing chroot tarball to install additional packages. This avoids re-downloading essential packages.

```bash
$ mmdebstrap --variant=apt unstable chroot.tar
```

```bash
$ mmdebstrap --variant=custom --skip=update,setup,cleanup,tar-in/mknod \
    --setup-hook='tar-in chroot.tar /' \
    --customize-hook='chroot "$1" apt-get install --yes pkg1 pkg2' \
    '' chroot-full.tar
```

--------------------------------

### Include usrmerge package for merged-/usr

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

To force mmdebstrap to create a chroot with merged-/usr using symlinks before Debian 12 (Bookworm), explicitly install the 'usrmerge' package.

```bash
--include=usrmerge
```

--------------------------------

### Configure hostname and hosts via customize-hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Sets the system hostname and updates the hosts file.

```bash
    --customize-hook='echo host > "$1/etc/hostname"'
    --customize-hook='echo "127.0.0.1 localhost host" > "$1/etc/hosts"'
```

--------------------------------

### Conditional merged-/usr setup hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

When the merged-/usr status is unknown, use '--hook-dir=/usr/share/mmdebstrap/hooks/maybe-merged-usr'. This hook decides whether to call the 'merged-usr' hook based on the availability of the 'usr-is-merged' package.

```bash
--hook-dir=/usr/share/mmdebstrap/hooks/maybe-merged-usr
```

--------------------------------

### Using signed-by for APT Repositories

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Explains the 'signed-by' option for APT repositories within mmdebstrap, which is crucial for verifying repository signatures.

```APIDOC
## Using signed-by for APT Repositories

### Description
This section details the use of the `signed-by` option in APT repository URIs within mmdebstrap. It ensures that APT inside the chroot trusts the repository's signature, especially when the keyring is not automatically trusted.

### Method
Command Line Tool Option

### Endpoint
N/A

### Parameters
#### Query Parameters
- **signed-by** (string) - Optional - Specifies the path to the GPG key file used to sign the repository. This option is added to the `sources.list` if the required keyring is not trusted by APT. Requires `gpg` to be installed within the chroot for automatic addition.

### Request Example
```bash
mmdebstrap bionic ubuntu-bionic.tar "deb [signed-by=/usr/share/keyrings/ubuntu-archive-keyring.gpg] http://archive.ubuntu.com/ubuntu bionic main"
```

### Response
N/A

#### Success Response (Chroot Configuration)
- **sources.list** (file) - The `sources.list` file within the created chroot will contain the `signed-by` option pointing to the specified keyring.
```

--------------------------------

### Create a buildd tarball for EOL distributions

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Use specific hooks and apt options to build older distributions like jessie.

```bash
$ mmdebstrap --include=apt --variant=buildd --aptopt \
    'Apt::Key::gpgvcommand "/usr/libexec/mmdebstrap/gpgvnoexpkeysig"' \
    --aptopt='Acquire::Check-Valid-Until "false"' \
    --keyring=/usr/share/keyrings/debian-archive-removed-keys.gpg \
    --hook-dir=/usr/share/mmdebstrap/hooks/maybe-jessie-or-older \
    jessie ~/.cache/sbuild/jessie-arm64.tar \
    http://archive.debian.org/debian
```

--------------------------------

### Build libdvdcss2.deb without system modification

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Build a specific .deb package by extracting it from a chroot created with mmdebstrap. This avoids installing anything or changing apt sources on the current system.

```bash
$ mmdebstrap --variant=apt --components=main,contrib --include=libdvd-pkg \
    --customize-hook='chroot $1 /usr/lib/libdvd-pkg/b-i_libdvdcss.sh' \
    | tar --extract --verbose --strip-components=4 \
        --wildcards './usr/src/libdvd-pkg/libdvdcss2_*_*.deb'
$ ls libdvdcss2_*_*.deb
```

--------------------------------

### Configure Apt Options for mmdebstrap

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Pass arbitrary options to apt that will be permanently added to /etc/apt/apt.conf.d/99mmdebstrap inside the chroot. Use hooks for temporary configurations. Multiple --aptopt arguments can be used.

```bash
--aptopt='Acquire::Check-Valid-Until "false"'
```

```bash
--aptopt='Apt::Key::gpgvcommand "/usr/libexec/mmdebstrap/gpgvnoexpkeysig"'
```

```bash
--aptopt='Acquire::Languages { "environment"; "en"; }'
```

```bash
--aptopt='Acquire::Languages "none"'
```

```bash
--aptopt='Apt::Install-Recommends "true"'
```

```bash
--aptopt='Acquire::http { Proxy "http://127.0.0.1:3142"; }'
```

```bash
--aptopt='APT::Sandbox::User "root"'
```

```bash
--aptopt='APT::Solver "aspcud"'
```

```bash
--aptopt='APT::Solver::aspcud::Preferences
       "-count(solution,APT-Release:=/a=experimental/),-removed,-changed,-new"'
```

--------------------------------

### Use bind-mount for package mirrors with mmdebstrap

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Make packages from an external directory available inside the chroot using a bind-mount. This avoids copying large amounts of data with sync-in and uses a file:// mirror.

```bash
$ mmdebstrap --variant=apt --skip=essential/unlink \
    --setup-hook='mkdir "$1/tmp/mirror"' \
    --setup-hook='mount -o ro,bind /tmp/mirror "$1/tmp/mirror"' \
    --customize-hook='sync-out /var/cache/apt/archives ./cache' \
    --customize-hook='umount "$1/tmp/mirror"; rmdir "$1/tmp/mirror";' \
    unstable /dev/null file:///tmp/mirror http://deb.debian.org/debian
```

--------------------------------

### Create a Docker image with mmdebstrap

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Create a Docker image from a mmdebstrap output. The output is piped directly to `docker import`.

```bash
$ mmdebstrap unstable | sudo docker import - debian
[...] 
$ sudo docker run -it --rm debian whoami
root
$ sudo docker rmi debian
```

--------------------------------

### Build a non-Debian chroot (Ubuntu bionic)

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Create a chroot environment for a non-Debian distribution like Ubuntu bionic. This requires specifying the appropriate keyring for apt.

```bash
$ mmdebstrap --aptopt='Dir::Etc::Trusted
       "/usr/share/keyrings/ubuntu-keyring-2012-archive.gpg"' bionic bionic.tar
```

--------------------------------

### Equivalent Hook Execution

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Demonstrates how --hook-dir can be a shorthand for specifying individual hook files. Scripts are added in the order options are given.

```bash
mmdebstrap --customize=./scriptA --hook-dir=./hooks --setup=./scriptB
```

```bash
mmdebstrap --customize=./scriptA --setup=./hooks/setup01-foo.sh \
        --setup=./hooks/setup02-bar.sh --setup=./scriptB
```

--------------------------------

### mmdebstrap Configuration Options

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Overview of command line flags for configuring components, architectures, and simulation modes.

```APIDOC
## --components

### Description
Comma or whitespace separated list of components (e.g., main, contrib, non-free) used for all URI-only MIRROR arguments.

### Parameters
- **comp** (string) - Required - List of components to include.

## --architectures

### Description
Comma or whitespace separated list of architectures. The first architecture is the native architecture inside the chroot.

### Parameters
- **arch** (string) - Required - List of architectures to support.

## --simulate / --dry-run

### Description
Run apt-get with --simulate. Only the package cache is initialized but no binary packages are downloaded or installed.
```

--------------------------------

### Specify Components for URI-only Mirrors

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Use this option to specify a comma or whitespace-separated list of components like main, contrib, non-free. The option can be specified multiple times, and components are concatenated. Duplicate components are dropped.

```bash
--components="main contrib non-free non-free-firmware"
--components=main,contrib,non-free,non-free-firmware
--comp=main --comp="contrib non-free" --comp="main,non-free-firmware"
```

--------------------------------

### mmdebstrap apt variant

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

This command shows how to achieve the 'apt' variant using the --variant=essential and --include="apt" options.

```bash
mmdebstrap --variant=essential --include="apt"

```

--------------------------------

### Add user via customize-hook

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Creates a new user and removes their password requirement.

```bash
    --customize-hook='chroot "$1" useradd --home-dir /home/user
        --create-home user'
    --customize-hook='chroot "$1" passwd --delete user'
```

--------------------------------

### Configure mirrors

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Override default mirror behavior by specifying sources manually.

```bash
$ mmdebstrap stable stable-chroot.tar
```

```bash
$ mmdebstrap stable stable-chroot.tar http://deb.debian.org/debian
$ mmdebstrap stable stable-chroot.tar "deb http://deb.debian.org/debian stable main"
$ mmdebstrap stable stable-chroot.tar /path/to/sources.list
$ mmdebstrap stable stable-chroot.tar - < /path/to/sources.list
```

--------------------------------

### Create a Podman image with mmdebstrap

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Create a Podman image from a mmdebstrap output. The output is piped directly to `podman import`.

```bash
$ mmdebstrap unstable | podman import - debian
[...] 
$ podman run --network=none -it --rm debian whoami
root
```

--------------------------------

### Basic mmdebstrap Usage

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1.en.html

Demonstrates the basic command structure for creating a chroot tarball.

```APIDOC
## Basic Usage

### Description
Creates a chroot tarball for a specified suite.

### Method
Command Line Tool

### Endpoint
N/A

### Parameters
#### Path Parameters
- **suite** (string) - Required - The distribution suite to install (e.g., 'mysuite').
- **output_file** (string) - Required - The path to the output tarball file (e.g., 'out.tar').

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
mmdebstrap mysuite out.tar "deb [signed-by=/path/to/key.gpg] http://..."
```

### Response
N/A (Creates a file)

#### Success Response (File Creation)
- **output_file** (tarball) - The created chroot tarball.
```

--------------------------------

### Core mmdebstrap logic in shell

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

A 14-line shell script demonstrating the fundamental operations performed by mmdebstrap to initialize a chroot environment.

```shell
    mkdir -p "$2/etc/apt" "$2/var/cache" "$2/var/lib"
    cat << END > "$2/apt.conf"
    Apt::Architecture "$(dpkg --print-architecture)";
    Apt::Architectures "$(dpkg --print-architecture)";
    Dir "$(cd "$2" && pwd)";
    Dir::Etc::Trusted "$(eval "$(apt-config shell v Dir::Etc::Trusted/f)"; printf %s "$v")";
    Dir::Etc::TrustedParts "$(eval "$(apt-config shell v Dir::Etc::TrustedParts/d)"; printf %s "$v")";
    END
    echo "deb http://deb.debian.org/debian/ $1 main" > "$2/etc/apt/sources.list"
    APT_CONFIG="$2/apt.conf" apt-get update
    APT_CONFIG="$2/apt.conf" apt-get --yes --download-only install '?essential'
    for f in "$2"/var/cache/apt/archives/*.deb; do dpkg-deb --extract "$f" "$2"; done
    chroot "$2" sh -c "dpkg --install --force-depends /var/cache/apt/archives/*.deb"
```

--------------------------------

### Configure components for MIRROR arguments

Source: https://manpages.debian.org/unstable/mmdebstrap/mmdebstrap.1

Specifies components for URI-only mirror arguments. Multiple declarations are concatenated and duplicates are automatically removed.

```bash
    --components="main contrib non-free non-free-firmware"
    --components=main,contrib,non-free,non-free-firmware
    --comp=main --comp="contrib non-free" --comp="main,non-free-firmware"
```
Tokens:
Raw