set service dns forwarding options "dhcp-match=set:bios,60,PXEClient:Arch:00000"
set service dns forwarding options "dhcp-boot=tag:bios,netboot.xyz.kpxe,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi32,60,PXEClient:Arch:00002"
set service dns forwarding options "dhcp-boot=tag:efi32,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi32-1,60,PXEClient:Arch:00006"
set service dns forwarding options "dhcp-boot=tag:efi32-1,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi64,60,PXEClient:Arch:00007"
set service dns forwarding options "dhcp-boot=tag:efi64,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi64-1,60,PXEClient:Arch:00008"
set service dns forwarding options "dhcp-boot=tag:efi64-1,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi64-2,60,PXEClient:Arch:00009"
set service dns forwarding options "dhcp-boot=tag:efi64-2,netboot.xyz.efi,,SERVERIP"
commit; save
</code></pre><h4id=dd-wrt>DD-WRT</h4><p>Administration -> Services -> Additional DNSMasq Options Set the following lines: </p><pre><code>dhcp-match=set:bios,60,PXEClient:Arch:00000
</code></pre><h4id=tomato>Tomato</h4><p>Advanced -> DHCP/DNS -> Dnsmasq Custom configuration Set the following lines: </p><pre><code>dhcp-match=set:bios,60,PXEClient:Arch:00000
</code></pre><h4id=openwrt>OpenWRT</h4><pre><code>uci set dhcp.@dnsmasq[0].dhcp_match=set:bios,60,PXEClient:Arch:00000
uci set dhcp.@dnsmasq[0].dhcp_boot=tag:bios,netboot.xyz.kpxe,,YOURSERVERIP
uci set dhcp.@dnsmasq[0].dhcp_match=set:efi32,60,PXEClient:Arch:00002
uci set dhcp.@dnsmasq[0].dhcp_boot=tag:efi32,netboot.xyz.efi,,YOURSERVERIP
uci set dhcp.@dnsmasq[0].dhcp_match=set:efi32-1,60,PXEClient:Arch:00006
uci set dhcp.@dnsmasq[0].dhcp_boot=tag:efi32-1,netboot.xyz.efi,,YOURSERVERIP
uci set dhcp.@dnsmasq[0].dhcp_match=set:efi64,60,PXEClient:Arch:00007
uci set dhcp.@dnsmasq[0].dhcp_boot=tag:efi64,netboot.xyz.efi,,YOURSERVERIP
uci set dhcp.@dnsmasq[0].dhcp_match=set:efi64-1,60,PXEClient:Arch:00008
uci set dhcp.@dnsmasq[0].dhcp_boot=tag:efi64-1,netboot.xyz.efi,,YOURSERVERIP
uci set dhcp.@dnsmasq[0].dhcp_match=set:efi64-2,60,PXEClient:Arch:00009
uci set dhcp.@dnsmasq[0].dhcp_boot=tag:efi64-2,netboot.xyz.efi,,YOURSERVERIP
uci commit
/etc/init.d/dnsmasq restart
</code></pre><h4id=microsoft-server-dhcp>Microsoft Server DHCP</h4><ul><li>Run the DHCP program</li><li>Under Scope/Scope Options</li><li>check option 066 and enter the FQDN or IP of your TFTP boot server</li><li>check option 067 and enter one of the following bootfile names:</li><li>Default BIOS file name- netboot.xyz.kpxe</li><li>UEFI 32 bit file name- netboot.xyz.efi</li><li>UEFI 64 bit file name- netboot.xyz.efi</li></ul><p>Anything else from a router standpoint is a crapshoot for supporting Dnsmasq options or proprietary PXE boot options, check Google for support (try your exact router model number with 'pxe boot') or look into setting up your own DHCP server in Linux.</p><p>This image also contains <code>netboot.xyz.efi</code> which can be used to boot using UEFI network boot. The UEFI boot and menu will have limited functionality if you choose to use it.</p><h2id=usage>Usage</h2><p>To help you get started creating a container from this image you can either use docker-compose or the docker cli.</p><h3id=docker-compose-recommended-click-here-for-more-info>docker-compose (recommended, <ahref=https://docs.linuxserver.io/general/docker-compose>click here for more info</a>)</h3><pre><codeclass=language-yaml>---
version: "2.1"
services:
netbootxyz:
image: lscr.io/linuxserver/netbootxyz:latest
container_name: netbootxyz
environment:
- PUID=1000
- PGID=1000
- MENU_VERSION=1.9.9 #optional
- PORT_RANGE=30000:30010 #optional
- SUBFOLDER=/ #optional
volumes:
- /path/to/config:/config
- /path/to/assets:/assets #optional
ports:
- 3000:3000
- 69:69/udp
- 8080:80 #optional
restart: unless-stopped
</code></pre><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)</h3><pre><codeclass=language-bash>docker run -d \
--name=netbootxyz \
-e PUID=1000 \
-e PGID=1000 \
-e MENU_VERSION=1.9.9 `#optional` \
-e PORT_RANGE=30000:30010 `#optional` \
-e SUBFOLDER=/ `#optional` \
-p 3000:3000 \
-p 69:69/udp \
-p 8080:80 `#optional` \
-v /path/to/config:/config \
-v /path/to/assets:/assets `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/netbootxyz:latest
</code></pre><h2id=parameters>Parameters</h2><p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)</h3><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>3000</code></td><td>Web configuration interface.</td></tr><tr><tdalign=center><code>69/udp</code></td><td>TFTP Port.</td></tr><tr><tdalign=center><code>80</code></td><td>NGINX server for hosting assets.</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)</h3><table><thead><tr><thalign=center>Env</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><tdalign=center><code>PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><tdalign=center><code>MENU_VERSION=1.9.9</code></td><td>Specify a specific version of boot files you want to use from NETBOOT.XYZ (unset pulls latest)</td></tr><tr><tdalign=center><code>PORT_RANGE=30000:30010</code></td><td>Specify the port range tftp will use for data transfers <ahref=https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol#Details>(see Wikipedia)</a></td></tr><tr><tdalign=center><code>SUBFOLDER=/</code></td><td>Specify a sobfolder if running this behind a reverse proxy (IE /proxy/)</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3><table><thead><tr><thalign=center>Volume</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>/config</code></td><td>Storage for boot menu files and web application config</td></tr><tr><tdalign=center><code>/assets</code></td><td>Storage for NETBOOT.XYZ bootable assets (live CDs and other files)</td></tr></tbody></table><h4id=miscellaneous-options>Miscellaneous Options</h4><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><pre><codeclass=language-bash>-e FILE__PASSWORD=/run/secrets/mysecretpassword
</code></pre><p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p><h2id=umask-for-running-applications>Umask for running applications</h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=user-group-identifiers>User / Group Identifiers</h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p><pre><codeclass=language-bash> $ id username
