README – SnapOS PXE Server Setup with USB and Windows DHCP Configuration
==============================================================
This document provides instructions to:

1. Flash the PXE Server image to a USB drive
2. Boot the PXE server
3. Configure Windows DHCP Server for PXE booting
4. Network boot clients to trigger the automatic SnapOS installation
5. Check the available license count and registered device details

==============================================================
1. PREPARE THE PXE SERVER USB
==============================================================
The provided PXE server image can be flashed using the Preplive script.

WARNING: This will overwrite the target device. Double-check
the device path before running.

1. Plug in your USB drive.
2. Identify it using:
lsblk
3. Run the script to flash using this command:
./Preplive.py -c -m nfs usb_noble.img /dev/sdx
(Replace with the actual license count and /dev/sdx with
your USB device)
4. Run:
sync
5. Eject the USB safely.

==============================================================
2. BOOTING THE PXE SERVER MACHINE
==============================================================
1. Insert the flashed USB drive into the machine that will act as the
PXE server.
2. Power on the system and enter BIOS/UEFI (F2, DEL, ESC, or similar).
3. Locate the SECURE BOOT settings and set:
Secure Boot = DISABLED
4. Open the boot menu (F12, F10, or similar) and select the USB drive.
You may see multiple entries (e.g., Partition 2 and Partition 4).
Select **Partition 2**, followed by the USB device.
5. Save the changes and exit BIOS/UEFI.

The PXE Server will automatically start after boot.

Note: – It is recommended to use USB 3.2 drives. Slower or low-quality
USB drives may cause delays or failures during PXE startup.
– If it is not working, run the command `docker ps` and ensure
the status is “healthy”.
– If not, wait until the status shows “healthy”.
– login credentials:
Username: snapadmin
Password: password

==============================================================
3. CONFIGURE WINDOWS DHCP SERVER FOR PXE BOOTING
==============================================================
If your network uses an existing Windows DHCP server, you must
configure PXE options so clients can find the PXE server.

These steps should be performed on the Windows Server that runs DHCP.
1. Open the DHCP management console and select “Configure Options”.
2. Set:
Option 066 – Boot Server Host Name
IP of the PXE server
Option 067 – Bootfile Name
For UEFI systems, set:
netboot.xyz.efi
3. Save and apply the changes.

NOTE: The PXE server must obtain its IP address from this DHCP server.

==============================================================
4. STARTING NETWORK BOOT ON CLIENT MACHINES
==============================================================
1. Connect the client machines to the same network as the PXE server and
DHCP server.
2. Power on the client and enter the boot menu (F12, F8, F10, ESC, etc.).
3. Select:
– Boot mode : “UEFI”
– Boot option : “Network boot option (PXE over IPv4)”
4. The client will receive its IP from the Windows DHCP server.
5. The DHCP server will direct the client to the PXE server using options 66/67.
6. The client should load netboot.xyz from your PXE USB server.

==============================================================
5. AUTOMATED OS INSTALLATION
==============================================================
The SnapOS PXE server provides a fully automated installation workflow.
After the client successfully boots into the SnapOS PXE environment:

– Required boot components are retrieved from the PXE server.
– The automated installer is launched without user interaction.
– SnapOS is installed or flashed automatically based on the configured
image.
– Upon successful completion, the client machine shuts down
automatically.

Note: A SnapOS license must be available for installation. If no
license is available, the installation will not proceed unless the
hardware address is already registered.

==============================================================
6. CHECKING THE AVAILABLE LICENSE COUNT AND REGISTERED DEVICE DETAILS
==============================================================
The SnapOS PXE server includes a script to check the available license
count and registered(installed) device details.

1. Execute the script:
python3 /usr/local/bin/license_mac_exporter.py
2. Open the exported file:
/etc/license_info.json

==============================================================
7. FINAL STEPS
==============================================================
– After installation, power on the system, enter the BIOS/UEFI, and select the normal/local-disk boot option to boot into SnapOS.
– Keep the PXE server powered on to continue auto-installing additional clients,or modify the DHCP configuration and safely eject the USB when PXE is no longer required.