[GH-ISSUE #17] Instructions on how to use the Github Custom menu #2

Closed
opened 2026-02-27 14:56:42 +03:00 by kerem · 3 comments
Owner

Originally created by @samip5 on GitHub (May 6, 2020).
Original GitHub issue: https://github.com/netbootxyz/netboot.xyz-docs/issues/17

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

Originally created by @samip5 on GitHub (May 6, 2020). Original GitHub issue: https://github.com/netbootxyz/netboot.xyz-docs/issues/17 Just making sure that this is in the backlog of docs to do.
kerem closed this issue 2026-02-27 14:56:43 +03:00
Author
Owner

@Patrick762 commented on GitHub (Jul 13, 2025):

Just to "document" it here for anyone who finds this:


To use a custom.ipxe file, you have to do the following:

  1. Modify the boot.cfg and add set menu custom-user
  2. Create a file by clicking the Menus option in the header of the webapp. Use the filename custom.ipxe.
  3. Now you have to replace the line chain custom/custom.ipxe with chain custom.ipxe in the menu.ipxe file
  4. Inside the created file, configure your custom menu. You can use the example provided at https://github.com/netbootxyz/netboot.xyz-custom/blob/master/custom.ipxe.example

Additional source for ipxe commands: https://ipxe.org/cmd
Another source for examples are the forks of the example repository at https://github.com/netbootxyz/netboot.xyz-custom/forks

<!-- gh-comment-id:3067249162 --> @Patrick762 commented on GitHub (Jul 13, 2025): Just to "document" it here for anyone who finds this: -------------- To use a custom.ipxe file, you have to do the following: 1. Modify the **boot.cfg** and add `set menu custom-user` 2. Create a file by clicking the Menus option in the header of the webapp. Use the filename `custom.ipxe`. 3. Now you have to replace the line `chain custom/custom.ipxe` with `chain custom.ipxe` in the **menu.ipxe** file 4. Inside the created file, configure your custom menu. You can use the example provided at https://github.com/netbootxyz/netboot.xyz-custom/blob/master/custom.ipxe.example Additional source for ipxe commands: https://ipxe.org/cmd Another source for examples are the forks of the example repository at https://github.com/netbootxyz/netboot.xyz-custom/forks
Author
Owner

@antonym commented on GitHub (Jul 14, 2025):

@claude can you take these notes and turn them into a document for the main docsite?

<!-- gh-comment-id:3067700036 --> @antonym commented on GitHub (Jul 14, 2025): @claude can you take these notes and turn them into a document for the main docsite?
Author
Owner

@claude[bot] commented on GitHub (Jul 14, 2025):

Claude finished @antonym's task —— View jobclaude/issue-17-20250714_032056Create PR ➔


Converting Notes to Documentation

I've successfully converted Patrick762's notes into comprehensive documentation for the main docsite.

Todo List:

  • Explore repository structure to understand documentation organization
  • Read existing documentation to understand format and style
  • Create documentation for the custom menu instructions
  • Format Patrick762's notes into proper documentation
  • Commit and push changes
  • Provide PR link for review

What was accomplished:

Created docs/custom-menus.md with comprehensive documentation that includes:

  • Step-by-step instructions based on Patrick762's notes
  • Proper iPXE syntax examples with a complete menu structure example
  • Links to additional resources (iPXE docs, example repository, community forks)
  • Best practices and troubleshooting section
  • Cross-references to related documentation

The documentation covers the web interface approach to custom menus, which complements the existing self-hosting documentation.


<!-- gh-comment-id:3067700323 --> @claude[bot] commented on GitHub (Jul 14, 2025): **Claude finished @antonym's task** —— [View job](https://github.com/netbootxyz/netboot.xyz-docs/actions/runs/16257139122) • [`claude/issue-17-20250714_032056`](https://github.com/netbootxyz/netboot.xyz-docs/tree/claude/issue-17-20250714_032056) • [Create PR ➔](https://github.com/netbootxyz/netboot.xyz-docs/compare/master...claude/issue-17-20250714_032056?quick_pull=1&title=Add%20documentation%20for%20custom%20menus%20using%20web%20interface&body=This%20PR%20adds%20comprehensive%20documentation%20for%20creating%20and%20using%20custom%20iPXE%20menus%20through%20the%20netboot.xyz%20web%20interface%2C%20based%20on%20community-provided%20instructions%20from%20issue%20%2317.%0A%0AThe%20documentation%20includes%3A%0A-%20Step-by-step%20setup%20instructions%0A-%20iPXE%20syntax%20examples%0A-%20Best%20practices%20and%20troubleshooting%0A-%20Links%20to%20additional%20resources%0A%0ACloses%20%2317%0A%0AGenerated%20with%20%5BClaude%20Code%5D(https%3A//claude.ai/code)) --- ### Converting Notes to Documentation I've successfully converted Patrick762's notes into comprehensive documentation for the main docsite. ### Todo List: - [x] Explore repository structure to understand documentation organization - [x] Read existing documentation to understand format and style - [x] Create documentation for the custom menu instructions - [x] Format Patrick762's notes into proper documentation - [x] Commit and push changes - [x] Provide PR link for review ### What was accomplished: Created `docs/custom-menus.md` with comprehensive documentation that includes: - Step-by-step instructions based on Patrick762's notes - Proper iPXE syntax examples with a complete menu structure example - Links to additional resources (iPXE docs, example repository, community forks) - Best practices and troubleshooting section - Cross-references to related documentation The documentation covers the web interface approach to custom menus, which complements the existing self-hosting documentation. ---
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-docs#2
No description provided.