README.md

   1 dracut
   2 ====
   3
   4 dracut is an event driven initramfs infrastructure.
   5
   6 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](.github/CODE_OF_CONDUCT.md)
   7 [![Fedora-32](https://github.com/dracutdevs/dracut/workflows/Fedora-32/badge.svg?branch=master)](https://github.com/dracutdevs/dracut/actions?query=workflow%3AFedora-32)
   8 [![Fedora-33](https://github.com/dracutdevs/dracut/workflows/Fedora-33/badge.svg?branch=master)](https://github.com/dracutdevs/dracut/actions?query=workflow%3AFedora-33)
   9 [![Fedora-latest](https://github.com/dracutdevs/dracut/workflows/Fedora-latest/badge.svg?branch=master)](https://github.com/dracutdevs/dracut/actions?query=workflow%3AFedora-latest)
  10
  11 dracut (the tool) is used to create an initramfs image by copying tools
  12 and files from an installed system and combining it with the
  13 dracut framework, usually found in /usr/lib/dracut/modules.d.
  14
  15 Unlike other implementations, dracut hard-codes as little
  16 as possible into the initramfs. The initramfs has
  17 (basically) one purpose in life -- getting the rootfs mounted so that
  18 we can transition to the real rootfs.  This is all driven off of
  19 device availability.  Therefore, instead of scripts hard-coded to do
  20 various things, we depend on udev to create device nodes for us and
  21 then when we have the rootfs's device node, we mount and carry on.
  22 This helps to keep the time required in the initramfs as little as
  23 possible so that things like a 5 second boot aren't made impossible as
  24 a result of the very existence of an initramfs.
  25
  26 Most of the initramfs generation functionality in dracut is provided by a bunch
  27 of generator modules that are sourced by the main dracut script to install
  28 specific functionality into the initramfs.  They live in the modules.d
  29 subdirectory, and use functionality provided by dracut-functions to do their
  30 work.
  31
  32 Currently dracut lives on github.com and kernel.org.
  33
  34 The tarballs can be found here:
  35         http://www.kernel.org/pub/linux/utils/boot/dracut/
  36         ftp://ftp.kernel.org/pub/linux/utils/boot/dracut/
  37
  38 Git:
  39         https://github.com/dracutdevs/dracut.git
  40         http://git.kernel.org/?p=boot/dracut/dracut.git
  41
  42 Project Documentation:
  43         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
  44
  45 Project Wiki:
  46         http://dracut.wiki.kernel.org
  47
  48 See the github issue tracker for things which still need to be done and HACKING.md
  49 for some instructions on how to get started.  There is also a mailing list
  50 that is being used for the discussion -- initramfs@vger.kernel.org.
  51 It is a typical vger list, send mail to majordomo@vger.kernel.org with body
  52 of 'subscribe initramfs email@host.com'
  53
  54
  55 Licensed under the GPLv2