Skip to content

Commit

Permalink
Add some notes about memory and dev process
Browse files Browse the repository at this point in the history
  • Loading branch information
antonym committed Jan 23, 2024
1 parent 1adb0d6 commit 0a5d5e5
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ chain --autofree http://boot.netboot.xyz/ipxe/netboot.xyz.efi

This will load the appropriate netboot.xyz kernel with all of the proper options enabled.

:::note
:::info

If your version of iPXE has HTTPS support compiled in, you can retrieve those images over HTTPS. By default the upstream iPXE project does not compile in HTTPS support.

Expand All @@ -34,20 +34,33 @@ If your version of iPXE has HTTPS support compiled in, you can retrieve those im
### System Requirements

- i686, x86_64, or aarch64 Processor
- 4GB of RAM is recommended. Lower amounts of memory can be used depending on how large the distribution is. Some distributions have to load a ramdisk into memory. If you experience issues when kernels are loading, this is generally one of the first things you should check and tune.
- Hard wired ethernet connection, Wifi support in iPXE is limited
- Bare Metal or Virtual Machine
- A hard wired ethernet connection (WiFi networking is not supported)
- At least 4GB of RAM is recommended

:::info

Memory requirements vary depending on the distribution. Live CD Images typically require a lot more memory as the ramdisk is needed to be loaded into memory. Live CD Images loaded over the network may need more than 4GB. If you experience issues where it fails to load during the initrd process, try giving the hardware or virtual machine more RAM. You will typically see errors like `out of space` or `failure to write to destination` in the initrd once the kernel has loaded if you don't have enough RAM.

:::

### Source Code

The source code for netboot.xyz is located on [Github](https://github.com/netbootxyz/netboot.xyz).

### Contributing

New version of an operating system out? Found one that network boots well with iPXE? Pull requests are welcomed and encouraged and helps out a ton! Feel free to issue a pull request for new versions or tools that you might find useful. Once merged into master, [Github Actions](https://github.com/netbootxyz/netboot.xyz/actions) will regenerate new versions of [iPXE from upstream](https://github.com/ipxe/ipxe) and deploy the latest changes to netboot.xyz. See more on contributing [here](https://netboot.xyz/docs/contributing).
Is there a new version of an operating system out? Have you found one that network boots well with iPXE? Pull requests are welcomed and encouraged and helps out the project! Feel free to issue a pull request for new versions or tools that you might find useful. Once merged into master, [Github Actions](https://github.com/netbootxyz/netboot.xyz/actions) will regenerate new versions of [iPXE from upstream](https://github.com/ipxe/ipxe) and deploy the latest changes to netboot.xyz. See more on contributing [here](https://netboot.xyz/docs/contributing).

### Testing New Features

Under the **Utilities** menu on netboot.xyz, there's an option for ["netboot.xyz endpoints"](https://github.com/netbootxyz/netboot.xyz/blob/development/roles/netbootxyz/templates/menu/nbxyz.ipxe.j2). Features or changes that have been merged into the development branch can be loaded here to be tested before they are merged into production.
Under the **Utilities** menu on netboot.xyz, there's an option for ["netboot.xyz endpoints"](https://github.com/netbootxyz/netboot.xyz/blob/development/roles/netbootxyz/templates/menu/nbxyz.ipxe.j2). Features or changes that have been merged into the development branch can be loaded here to be tested before they are merged into production.

:::info

Version updates are typically deployed to the development endpoint and the primary rolling endpoint at the same time automatically. Once the development branch stabilizes, a new release is cut from the development branch and merged into master. This provides our stable point releases and releases new changes and capabilities related to menus or new features.

:::

### Communication

Expand Down

0 comments on commit 0a5d5e5

Please sign in to comment.