diff --git a/.getopt.sh b/.getopt.sh index 96eedc6..00bbac3 100644 --- a/.getopt.sh +++ b/.getopt.sh @@ -4,10 +4,7 @@ # -a | --arch # -v | --verbose # -D | --debug -# -s | --salt # -h | --help -# --installer -# --live # --variant # --version # --subdir @@ -15,5 +12,5 @@ # --no-clean # --clean -BUILD_OPTS_SHORT="d:pa:vDsh" -BUILD_OPTS_LONG="distribution:,proposed-updates,arch:,verbose,debug,salt,installer,live,variant:,version:,subdir:,get-image-path,no-clean,clean,help" +BUILD_OPTS_SHORT="d:pa:vDh" +BUILD_OPTS_LONG="distribution:,proposed-updates,arch:,verbose,debug,variant:,version:,subdir:,get-image-path,no-clean,clean,help" diff --git a/.gitignore b/.gitignore index 94591ef..1467c8a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,37 +1,15 @@ -# Directories -.build/* -binary/* -binary.*/* -cache/* -chroot/* -config/* +## Directories +.build/ +cache/ +chroot/ +## `lb` will generate this folder, `config` +## Which is why our config directory is called `kali-config` +config/ +## Incase symlink, no slash images -local/* -simple-cdd/images/* -simple-cdd/tmp/* -# Files +## Files +.lock .mirror -binary.modified_timestamps build.log -chroot.files -chroot.packages.install -chroot.packages.live -config/binary -config/bootstrap -config/common -config/source -live-image-*.contents -live-image-*.files -live-image-*.hybrid.iso.zsync -live-image-*.packages wget-log* - -# Overwritten due to build.sh -simple-cdd/debian-cd/* -simple-cdd/profiles/kali.downloads - -# Miscellaneous -.lock -.stage -prepare.log diff --git a/README.md b/README.md index 9cf42dc..e7fa8b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,82 @@ -# live-build configuration for Kali ISO images +# Kali-Live Build-Scripts + +_`live-build` configuration for Kali ISO images._ + +These are the same [build-scripts](https://gitlab.com/kalilinux/build-scripts) that the [Kali team](https://www.kali.org/) uses to generate the official Kali Linux base images, found here: [kali.org/get-kali/](https://www.kali.org/get-kali/). + +_Build your Kali Linux image today!_ + +- - - + +These images can be used to live boot into Kali, from such a USB/CD/DVD/sdCard, as well offers a basic installation. For more customization during setup, see [kali-installer](https://gitlab.com/kalilinux/build-scripts/kali-installer). + +- [kali-installer](https://gitlab.com/kalilinux/build-scripts/kali-installer) uses [Simple-CDD](https://wiki.debian.org/Simple-CDD) _(which is a wrapper for [debian-cd](https://wiki.debian.org/debian-cd))_ +- [kali-live](https://gitlab.com/kalilinux/build-scripts/kali-live) uses [live-build](https://live-team.pages.debian.net/live-manual/html/live-manual/index.en.html) + +- - - Have a look at [Live Build a Custom Kali ISO](https://www.kali.org/docs/development/live-build-a-custom-kali-iso/) for explanations on how to use this repository. + +There are also other [code examples of live-build](https://gitlab.com/kalilinux/recipes/live-build-config-examples), as well as [code examples for pre-seed to automate/unattended installation](https://gitlab.com/kalilinux/recipes/kali-preseed-examples). + +- - - + +## Help + +```console +$ ./build.sh --help +Usage: ./build.sh [