netbootxyz / netboot.xyz-docs Goto Github PK

Official netboot.xyz is created, now need to write up docs on usage.

Test

Please add instructions for the TFTPD_OPTS environment variable.

When creating a container on a Synology NAS in Container Manager this environment variable came up as required.

Also please add instructions and or reasoning for making the container network HOST and not BRIDGE so the network ports can be accessed on the LAN network.

Look into creating a new logo that better represents the project. Would probably avoid the typical shoe logo that many projects use for Netboot.

Need multiple image updates for the main netboot.xyz page as well. The iPXE logo is sufficient but would be nice to update the other images to make them unique.

Need dark mode and light mode SVGs for site as well.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Good reference here:

https://blog.siddhant-shah.com/install-debian-on-oracle-cloud-netboot/

Markdown tables are unaligned and different sizes... need to look into making the tables full width or cleaner so they are all aligned, or make the download page look a bit cleaner. (how https://boot.netboot.xyz tables are clean)

Hello,

Really not a big problem, so don't rush to fix it :)
Just noticed that step 8 is on the same line as step 7.

Put together docs on using netboot.xyz in a Hyper-V Server or Windows machine.

test

Currently docs only reference VMware Fusion instructions... should expand these out to provide better instructions for ESX, Fusion, Workstation, and other use cases.

Is your feature request related to a problem? Please describe.

Describe the solution you'd like
It would be usefull if the documentation mentioned Ventoy and how to use netboot.xyz together with a USB setup with Ventoy.

Describe alternatives you've considered

Additional context

At the page of https://netboot.xyz/#testing-new-branches, the ref of "Test netboot.xyz branch" seems broken.

BTW, with the latest netboot.xyz.iso, the option is also gone. Where can I get how to test new branch?

Thank you very much.

Enable dark mode in Docusaurus theme, need to set changing of theme to flip back and forth from svg logo. Logic for css needs to be changed to identify mode and flip to these:

https://github.com/netbootxyz/netboot.xyz-docs/blob/master/static/img/nbxyz-logo-dark.svg

https://github.com/netbootxyz/netboot.xyz-docs/blob/master/static/img/nbxyz-logo.svg

Source file here:

https://github.com/netbootxyz/netboot.xyz-docs/blob/master/src/components/HomepageFeatures.js

I've used netboot.xyz to install or run linux distros on the past but now I'm struggling to install Windows 10. I'm not sure what I'm doing wrong as I cannot find any useful information on the internet. Here is what I tried:

1. Download Windows 10 iso from here, extract and serve files through http
2. Launch netboot.xyz (using tftp)
3. Select windows on the menu. It pulls the files successfully
4. The installer starts, but as soon as I click on "Install now" to begin the installation I get this error:
   

I also tried mounting the files on a samba share and accessing them within the installer, but I had no success (I'm not even sure if it isn't finding some file or what's causing the error to pop)

Thanks in advance

Is your feature request related to a problem? Please describe.

In netbootxyz/netboot.xyz@be90bb7 there is an additional option "kernel_params" that was added, but I don't see any documentation for it.

We have a need in some circumstances to override the console location and configuration on some systems, it looks plausible that the "kernel_params" option might provide that capability but I'm unclear as to how it's intended to be used.

Describe the solution you'd like

Brief documentation on how to use the "kernel_params" option to override kernel defaults, and some worked out use cases where that makes sense.

Describe alternatives you've considered

The other thing that had come up in discussion was a request specifically to parameterize the TTY console options, but if there's a more general way to do it that already works we can follow that path.

Additional context

The idea would be to document how to detect RPi4 platform in DHCP. If at all possible.
I guess it would be already documented if it was, but otherwise would be good to understand why it's not possible.

It would sit in this section
https://netboot.xyz/docs/docker#examples

option arch code 93 = unsigned integer 16;

subnet 192.168.0.0 netmask 255.255.255.0 {
  range 192.168.0.34 192.168.0.254;       # Change this range as appropriate for your network
  next-server 192.168.0.33;               # Change this to the address of your DHCP server
  option subnet-mask 255.255.255.0;
  option routers 192.168.0.1;             # Change this to the address of your router
  option broadcast-address 192.168.0.255;
  option domain-name "mynetwork.lan";     # This is optional
  option domain-name-servers 1.1.1.1;
  if exists user-class and ( option user-class = "iPXE" ) {
    filename "http://boot.netboot.xyz/menu.ipxe";
  } elsif option arch = encode-int ( 16, 16 ) {
    filename "http://boot.netboot.xyz/ipxe/netboot.xyz.efi";
    option vendor-class-identifier "HTTPClient";
  } elsif option arch = 00:07 {
    filename "netboot.xyz.efi";
  } else {
    filename "netboot.xyz.kpxe";
  }
}

this should include an option to assign netboot.xyz-rpi4-snp.efi if some detection is possible.

Update the netboot.xyz example gif. It's outdated and there has been a lot of new options added since original creation.

Quickly demonstrate the capabilities of netboot.xyz in a short, small animated gif to replace the one here:

https://github.com/netbootxyz/netboot.xyz-docs/blob/master/static/img/netboot.xyz.gif

Just making sure that this is in the backlog of docs to do.