forked from pojntfx/ipxe-binaries
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Rewrite README to fit new conventions
Signed-off-by: Felicitas Pojtinger <[email protected]>
- Loading branch information
Showing
1 changed file
with
26 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,45 @@ | ||
| # iPXE Binaries | ||
|
|
||
| Weekly builds of [https://ipxe.org/](ipxe.org), with an [embedded script that chainloads /config.ipxe](./downstream/init.ipxe). | ||
| Weekly builds of [https://ipxe.org/](ipxe.org), with an [embedded script that chainloads /config.ipxe](./config/init.ipxe). | ||
|
|
||
| [](https://github.com/pojntfx/ipxe-binaries/actions/workflows/hydrun.yaml) | ||
|
|
||
| ## Overview | ||
|
|
||
| **Tired of re-compiling iPXE just to change the embedded script?** This repository, which provides builds of iPXE with an embedded script that chainloads `/config.ipxe` relative to the TFTP server that iPXE was booted from, might be of help to you! | ||
|
|
||
| A release `.tar.gz` archive with the latest iPXE release is built weekly and uploaded to [GitHub releases](https://github.com/pojntfx/ipxe-binaries/releases). | ||
|
|
||
| Binaries are compiled with HTTPS support enabled and are being built for the following [iPXE build targets](https://ipxe.org/appnote/buildtargets): | ||
| Binaries are build with HTTPS support enabled for the following [iPXE build targets](https://ipxe.org/appnote/buildtargets): | ||
|
|
||
| - `bin-i386-pcbios/ipxe.kpxe` | ||
| - `bin-i386-efi/ipxe.efi` | ||
| - `bin-x86_64-efi/ipxe.efi` | ||
| - `bin-arm32-efi/snp.efi` | ||
| - `bin-arm64-efi/snp.efi` | ||
|
|
||
| Also included is a [bofied](https://github.com/pojntfx/bofied) configuration file ([config.go](./downstream/config.go)) and an example iPXE script ([config.ipxe](./downstream/config.ipxe)) which chainloads [netboot.xyz](https://netboot.xyz/). | ||
| Also included is a [bofied](https://github.com/pojntfx/bofied) configuration file ([config.go](./config/config.go)) and an example iPXE script ([config.ipxe](./config/config.ipxe)) which chainloads [netboot.xyz](https://netboot.xyz/). | ||
|
|
||
| ## Installation | ||
|
|
||
| A release `.tar.gz` archive with the latest iPXE release is built weekly and uploaded to [GitHub releases](https://github.com/pojntfx/ipxe-binaries/releases). [bofied](https://github.com/pojntfx/bofied) automatically fetches this archive on its first startup by default. | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| - [ipxe/ipxe](https://github.com/ipxe/ipxe) provides the sources that the binaries are built from. | ||
|
|
||
| ## Contributing | ||
|
|
||
| To contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md). | ||
|
|
||
| To build the `.tar.gz` archive with the latest iPXE release locally, run the following: | ||
|
|
||
| ```shell | ||
| $ git clone https://github.com/pojntfx/ipxe-binaries.git | ||
| $ cd ipxe-binaries | ||
| $ hydrun -o debian:bookworm -i ./Hydrunfile c | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| ipxe-binaries (c) 2021 Felicitas Pojtinger and contributors | ||
| iPXE Binaries (c) 2024 Felicitas Pojtinger and contributors | ||
|
|
||
| SPDX-License-Identifier: GPL-2.0 |