{"id":15510337,"url":"https://github.com/ananace/foreman_ipxe","last_synced_at":"2025-04-23T03:01:37.141Z","repository":{"id":56847464,"uuid":"102116952","full_name":"ananace/foreman_ipxe","owner":"ananace","description":"Support for selectively booting chainloaded iPXE with Foreman","archived":false,"fork":false,"pushed_at":"2018-10-11T11:25:18.000Z","size":38,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T12:39:29.411Z","etag":null,"topics":["foreman-ipxe","ipxe","theforeman"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ananace.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-01T13:42:39.000Z","updated_at":"2021-08-31T21:27:50.000Z","dependencies_parsed_at":"2022-09-12T11:44:33.702Z","dependency_job_id":null,"html_url":"https://github.com/ananace/foreman_ipxe","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ananace%2Fforeman_ipxe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ananace%2Fforeman_ipxe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ananace%2Fforeman_ipxe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ananace%2Fforeman_ipxe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ananace","download_url":"https://codeload.github.com/ananace/foreman_ipxe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250360480,"owners_count":21417720,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["foreman-ipxe","ipxe","theforeman"],"created_at":"2024-10-02T09:47:51.935Z","updated_at":"2025-04-23T03:01:37.058Z","avatar_url":"https://github.com/ananace.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Foreman iPXE\n\nAdds in PXE loaders for chainloaded iPXE (`undionly.kpxe`, `ipxe.efi`)\n\nThis is useful for when you want to selectively chainload specific hosts into iPXE without affecting all other machines with the same OS.\n\n\n## Installation\n\nFollow the Foreman manual for [advanced installation from gems](https://theforeman.org/plugins/#2.3AdvancedInstallationfromGems)\n\nFor full usage of this plugin, you might want to create at least a global default iPXE boot template.\nYou can also specify a local boot template if need be, though in the case one is missing then a default template will be rendered that just closes iPXE and lets BIOS/UEFI continue the boot with the next device.\n\n## Compatibility\n\n| Foreman Version | Plugin Version |\n| --------------- | --------------:|\n| \u003e= 1.14         | ~\u003e 0.1         |\n| \u003e= 1.18         | ~\u003e 0.2         |\n| \u003e= 1.20         | *merged in Foreman* |\n\n## Usage\n\n### Global\n\nThis plugin adds global iPXE templates for hosts, if your DHCP is set up to always boot iPXE on all hosts - or hosts have iPXE embedded as their boot software.\n\nYou'll need to create a global default template for iPXE to support this feature, an example given below;\n\n```erb\n\u003c%#\nkind: iPXE\nmodel: ProvisioningTemplate\nname: iPXE global default\nsnippet: false\n-%\u003e\n#!ipxe\n\nset menu-default local\nset menu-timeout 5000\n\n:start\nmenu iPXE global boot menu\nitem --key l local     Continue local boot\nitem shell             Drop into iPXE shell\nitem reboot            Reboot system\nitem\nitem --key d discovery Foreman Discovery\nchoose --timeout ${menu-timeout} --default ${menu-default} selected || goto cancel\nset menu-timeout 0\ngoto ${selected}\n\n:cancel\necho Menu canceled, dropping to shell\n\n:shell\necho Use the command 'exit' to return to menu\nshell\nset menu-timeout 0\ngoto start\n\n:failed\necho Boot failed, dropping to shell\ngoto shell\n\n:reboot\nreboot\n\n:local\nexit\n\n:discovery\ndhcp\nkernel ${next-server}/boot/fdi-image/vmlinuz0 rootflags=loop root=live:/fdi.iso rootfstype=auto ro rd.live.image acpi=force rd.luks=0 rd.md=0 rd.dm=0 rd.lvm=0 rd.bootif=0 rd.neednet=0 nomodeset proxy.url=\u003c%= foreman_server_url %\u003e proxy.type=foreman BOOTIF=01-${net0/mac}\ninitrd ${next-server}/boot/fdi-image/initrd0.img\nboot || goto failed\ngoto start\n```\n\nIf you need to set a host-specific iPXE template, you can set the host parameter `iPXE_Template` to the name of the template that should be rendered for it.\n\n### Chainloading\n\n#### Without DHCP setup\n\nTo use the chainloading, you need to generate the iPXE executables first.\n\n```sh\ngit clone git://git.ipxe.org/ipxe.git\ncd ipxe/src\n\ncat \u003c\u003cEOF \u003e default.ipxe\n#!ipxe\n\ndhcp\nchain https://foreman.example.com/unattended/iPXE\nEOF\n\nmake bin/undionly.kpxe EMBED=default.ipxe\nmake bin-x86_64-efi/ipxe.efi EMBED=default.ipxe\n```\n\nThe generated executables should then be uploaded to the root of your TFTP server (or depending on your root path DHCP option).\n\n#### With DHCP setup\n\nInstall the officially available iPXE executables (`undionly.kpxe`, `ipxe.efi`) into your TFTP server, then follow the [iPXE guide for \"breaking the loop\"](http://ipxe.org/howto/chainloading#breaking_the_loop_with_the_dhcp_server).\n\nYou want to add a rule that passes the bootfile \"https://foreman.example.com/unattended/iPXE\" to any client reporting in as user class \"iPXE\".\n\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/ananace/foreman_ipxe\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fananace%2Fforeman_ipxe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fananace%2Fforeman_ipxe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fananace%2Fforeman_ipxe/lists"}