t1mbo / mkstage4

Bash Utility for Creating Stage 4 Tarballs

mkstage4

This is a Bash script which creates “stage 4” tarballs (i.e. system archives) either for the running system, or a system at a specified mount point. The script was inspired by an earlier mkstage4 script by Greg Fitzgerald (unmaintained as of 2012) which itself was a revamped edition of the original mkstage4 by Reto Glauser (unmaintained as of 2009).

Installation

The script can be run directly from its containing folder (and thus, is installed simply by downloading or cloning it from here - and adding run permissions):

git clone https://github.com/TheChymera/mkstage4.git /your/mkstage4/directory
cd /your/mkstage4/directory
chmod +x cpstage4.sh exstage4.sh mkstage4.sh

For Gentoo Linux and Derivatives, mkstage4 is also available in Portage via the base Gentoo overlay. On any Gentoo system, just run the following command:

emerge app-backup/mkstage4

Usage

If you are running the script from the containing folder (first install method) please make sure you use the e.g. ./mkstage4.sh command instead of just mkstage4!

Note that the extension (e.g. .tar.xz) will be automatically appended to the archive_name string which you specify in calling the mkstage4 command. This is done based on the compression type, which can be specifiled via the -C parameter, if another compression than the default (bz2, creating files ending in .tar.bz2) is desired.

Examples

Archive your current system (mounted at /):

mkstage4 -s archive_name

Archive a system located at a custom mount point:

mkstage4 -t /custom/mount/point archive_name

Copy a system to a separate drive, e.g. for quick backup.

cpstage4 / /run/media/myuser/mybackupdrive

Command line arguments

Usage:
	mkstage4.sh [-b -c -k -l -q] [-C <compression-type>] [-s || -t <target-mountpoint>] [-e <additional excludes dir*>] [-i <additional include target>] <archive-filename> [custom-tar-options]
	-b: excludes boot directory.
	-c: excludes some confidential files (currently only .bash_history and connman network lists).
	-k: separately save current kernel modules and src (creates smaller archives and saves decompression time).
	-l: excludes lost+found directory.
	-q: activates quiet mode (no confirmation).
	-C: specify tar compression (default: bz2, available: lz4 xz bz2 zst gz).
	-s: makes tarball of current system.
	-t: makes tarball of system located at the <target-mountpoint>.
	-e: an additional excludes directory (one dir one -e, donot use it with *).
	-i: an additional target to include. This has higher precedence than -e, -t, and -s.
	-h: displays help message.

System Tarball Extraction

Automatic (Multi-threaded)

We provide a script for convenient extraction, exstage4, which is shipped with this package. Currently it simply automates the Multi-threaded extraction selection listed below and otherwise has no functionality except checking that the file name looks sane. If in doubt, use one of the explicit extraction methods described below. Otherwise, you can extract an archive inplace with:

exstage4 archive_name.tar.bz2

Explicit Single-threaded

Tarballs created with mkstage4 can be extracted with:

To preserve binary attributes and use numeric owner identifiers, you can simply append the relevant flags to the respective tar commands, e.g.:

tar xvjpf archive_name.tar.bz2 --xattrs-include='*.*' --numeric-owner

If you use the -k option, extract the src and modules archives separately:

tar xvjpf archive_name.tar.bz2.kmod
tar xvjpf archive_name.tar.bz2.ksrc

Explicit Multi-threaded

If you have a parallel de/compressor installed, you can extract the archive with one of the respective commands:

pbzip2

tar -I pbzip2 -xvf archive_name.tar.bz2 --xattrs-include='*.*' --numeric-owner

xz

tar -I 'xz -T0' -xvf archive_name.tar.xz --xattrs-include='*.*' --numeric-owner

gzip

Similarly to other compressors, gzip uses a separate binary for parallel decompression:

tar -I unpigz -xvf archive_name.tar.gz --xattrs-include='*.*' --numeric-owner

Dependencies

Please note that these are very basic dependencies and should already be included in any Linux system.

• Bash - in Portage as app-shells/bash
• tar - in Portage as app-arch/tar
• bzip2 - in Portage as app-arch/bzip2 (single thread, default compression)

Optionals: If one the following is installed the archive will be compressed using multiple parallel threads when available, in order of succession:

• -C xz:

  • xz - in Portage as app-arch/xz, (parallel)
  • pixz - in Portage as app-arch/pixz, (parallel, indexed)

• -C bz2:

  • pbzip2 - in Portage as app-arch/pbzip2, (parallel)
  • lbzip2 - in Portage as app-arch/lbzip2, (parallel, faster and more efficient)

• -C gz:

  • gzip - in Portage as app-arch/gzip, (single thread)
  • pigz - in Portage as app-arch/pigz, (parallel)

• -C lrz:

  • lrzip - in Portage as app-arch/lrzip, (parallel)

• -C lz:

  • lzip - in Portage as app-arch/lzip, (single thread)
  • plzip - in Portage as app-arch/plzip, (parallel)

• -C lz4:

  • lz4 - in Portage as app-arch/lz4, (parallel)

• -C lzo:

  • lzop - in Portage as app-arch/lzop, (parallel)

• -C zstd:

  • zstd - in Portage as app-arch/zstd, (parallel)