diff --git a/README.md b/README.md new file mode 100644 index 0000000..693c8d4 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +

Pixy

+

All-in-one DHCP, TFTP, and HTTP PXE server

+ +
+All in one solution for the beast of a problem that PXE usually offers up. +
+
+

TFTP

+
+All pxeboot image files are embedded inside the binary for ease of use. Designed to use pxelinux as the bootloader. +The "default" file in the root directory is served as "pxelinux.cfg" allowing users to modify it even at runtime. +
+

HTTP

+
+Intended to be the source of all boot images. +
+

DHCP

+
+Gives out addresses using a golang DHCP implementation. +
+
+

Usage

+ +Running the binary without arguments: + - Attempts to locate the default network interface and IP address, and binds to those + +With arguments: + - ./Pixy \ \ + - Attempts to bind to supplied interface and address + +Requires sudo/root on linux +