[GH-ISSUE #1127] Missing info from netboot's documentation #305

Closed
opened 2026-02-27 14:51:16 +03:00 by kerem · 2 comments
Owner

Originally created by @danboid on GitHub (Jun 16, 2022).
Original GitHub issue: https://github.com/netbootxyz/netboot.xyz/issues/1127

I thought I might as well bundle all the things I think need to be added or improved in the current netboot documentation into one ticket to reduce clutter.

The Docker page ( https://netboot.xyz/docs/docker ) currently states that when you use docker run to create your netboot container, specifying a path for the assets is optional. It seems to me that if you don't provide an assets path the netboot web interface doesn't work (doesn't get configured?) at all and I've not found a working setting for the assets path, if there is one? Maybe this feature (local assets usage) has never worked?

@antonym have you tested the local assets feature of the netboot docker container?

I opened this issue for my assets problem https://github.com/netbootxyz/docker-netbootxyz/issues/24

The Self-hosted page seems mistitled. What most people prob want for 'self-hosted' is explained on the Docker page. The self-hosted page seems to be for those who want to fully customise netboot / netboot devs not just how to set up a local instance which is what I expected to see on the self-hosted page. We should explain this at the top of the self-hosted page if we don't rename that page to make it less confusing. I think the self-hosted page should be called 'Developers' and the Docker page 'Self-hosted', or just leave that as Docker.

Has anyone written a guide for extracting the Windows install ISO for installation via netboot? Windows is currently missing from the supported OSs list in the FAQ but there's no point in adding it until we tell people how they can install it via netboot.

netboot's lack of support for secure boot should be covered in the FAQ https://netboot.xyz/docs/faq - I should be able to do a PR to fix this one now if I can find the correct repo.

Originally created by @danboid on GitHub (Jun 16, 2022). Original GitHub issue: https://github.com/netbootxyz/netboot.xyz/issues/1127 I thought I might as well bundle all the things I think need to be added or improved in the current netboot documentation into one ticket to reduce clutter. The Docker page ( https://netboot.xyz/docs/docker ) currently states that when you use `docker run` to create your netboot container, specifying a path for the assets is optional. It seems to me that if you don't provide an assets path the netboot web interface doesn't work (doesn't get configured?) at all and I've not found a working setting for the assets path, if there is one? Maybe this feature (local assets usage) has never worked? @antonym have you tested the local assets feature of the netboot docker container? I opened this issue for my assets problem https://github.com/netbootxyz/docker-netbootxyz/issues/24 The Self-hosted page seems mistitled. What most people prob want for 'self-hosted' is explained on the Docker page. The self-hosted page seems to be for those who want to fully customise netboot / netboot devs not just how to set up a local instance which is what I expected to see on the self-hosted page. We should explain this at the top of the self-hosted page if we don't rename that page to make it less confusing. I think the self-hosted page should be called 'Developers' and the Docker page 'Self-hosted', or just leave that as Docker. Has anyone written a guide for extracting the Windows install ISO for installation via netboot? Windows is currently missing from the supported OSs list in the FAQ but there's no point in adding it until we tell people how they can install it via netboot. netboot's lack of support for secure boot should be covered in the FAQ https://netboot.xyz/docs/faq - I should be able to do a PR to fix this one now if I can find the correct repo.
kerem 2026-02-27 14:51:16 +03:00
Author
Owner

@danboid commented on GitHub (Jun 16, 2022):

I've added the Secure Boot QA to the FAQ

https://github.com/netbootxyz/netboot.xyz-docs/pull/58

<!-- gh-comment-id:1157445088 --> @danboid commented on GitHub (Jun 16, 2022): I've added the Secure Boot QA to the FAQ https://github.com/netbootxyz/netboot.xyz-docs/pull/58
Author
Owner

@antonym commented on GitHub (Aug 27, 2022):

If there are any additional docs to add, please feel free to open PRs. Thanks!

<!-- gh-comment-id:1229229367 --> @antonym commented on GitHub (Aug 27, 2022): If there are any additional docs to add, please feel free to open PRs. Thanks!
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/netboot.xyz#305
No description provided.