====== Documentation ======

===== Reference material =====

  * Using the iPXE [[:cmdline|command line]]
  * Writing [[:scripting|scripts]] using iPXE commands
  * Configuring [[:console|consoles]] (serial, graphical framebuffer, syslog, etc.)
  * Using [[:crypto|cryptography]] for HTTPS or code-signing
  * List of [[:cmd|all iPXE commands]]
  * List of [[:cfg|all iPXE settings]]
  * List of [[:buildcfg|all iPXE build options]]

{{ :clipart:books.png?200x200|Some books}}

===== Howto guides =====

==== Starting iPXE ====

  * How to [[:howto:chainloading|chainload iPXE]] using an existing PXE ROM
  * How to [[:howto:romburning|burn iPXE into ROM]]
  * How to [[:howto:vmware|use iPXE in VMware]]
  * How to [[:howto:ec2|use iPXE in Amazon EC2]]

==== DHCP ====

  * How to use [[:howto:dhcpd|ISC dhcpd]] with iPXE
  * How to use the [[:howto:msdhcp|Microsoft DHCP server]] with iPXE

==== Operating systems ====

  * How to [[:howto:rh_san|install RHEL, CentOS, or Fedora to an iSCSI or FCoE target]]
  * How to [[:howto:winpe|boot Windows PE via HTTP]]
  * How to [[:howto:sccm|boot System Center Configuration Manager (SCCM) via HTTP]]
  * How to [[:howto:wds_iscsi|install to an iSCSI target using Windows Deployment Services (WDS)]]

==== Troubleshooting ====

  * How to [[:howto:pcap|capture a packet trace]]
  * How to [[:howto:bisect|use git-bisect]] to track down a bug in iPXE
  * List of [[:appnote:hardware_drivers|hardware drivers]] expected to work

===== External documentation =====

  * [[http://networkboot.org|NetworkBoot.org]] - a place where beginners can learn the fundamentals of network booting
  * [[:examples|Examples]] of complete solutions built around iPXE

===== Application notes =====

  * Booting [[:appnote:chainload_wds|Windows Deployment Services]] using iPXE
  * Booting [[:appnote:ubuntu_live|Ubuntu Live]] from an NFS server
  * Installing [[:appnote:xenserver|XenServer]] using iPXE
  * Installing Windows XP or 2003 [[:appnote:xp_2003_direct_install|directly to an iSCSI target]]
  * Installing Windows Server 2008 [[:appnote:srp_install|directly to an SRP SAN target]]
  * Booting [[:appnote:windowsdisklessaoe|Windows disklessly with AoE (ATA over Ethernet)]]
  * [[:appnote:winpe_with_iscsi|Manually connecting to iSCSI targets]] using WinPE 3.0
  * Changing the [[:appnote:userclass|DHCP User Class]] sent by iPXE
  * List of [[:appnote:iscsi_targets|known-working iSCSI targets]]
  * Description of the [[:appnote:wimboot_architecture|internal architecture of wimboot]]
  * UEFI Secure Boot signing using a [[:appnote:etoken|DigiCert eToken]]
  * Chainloading iPXE via [[:appnote:uefihttp|UEFI HTTP Boot]]
  * Chainloading iPXE from a [[:appnote:netware_rpl|NetWare RPL boot ROM]]
  * Supporting broken TFTP clients with [[:appnote:tftpd-hpa]]
  * Booting Debian with preseed specified [[:appnote:debian_preseed]]
  * The possible [[:appnote:buildtargets|build targets]] for make.

===== Developer documentation =====

  * Guidance for [[:dev:driver|driver development]]
  * Description of iPXE's non-blocking internal [[:appnote:interfaces|message-passing interfaces]]

iPXE source code is documented using [[http://www.doxygen.org|Doxygen]]; you can browse the resulting documentation at [[http://dox.ipxe.org/files.html]].

iPXE is verified using [[https://github.com/features/actions|GitHub Actions]] for automated [[https://github.com/ipxe/ipxe/actions?query=workflow%3ABuild+branch%3Amaster|build and unit testing]], and [[https://scan.coverity.com|Coverity Scan]] for [[https://scan.coverity.com/projects/ipxe-ipxe|static analysis]].