diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 2f5bce8..0000000 --- a/docs/README.md +++ /dev/null @@ -1,98 +0,0 @@ -# Zero-OS Bootstrap Service - -The Zero-OS Bootstrap Service is available on [bootstrap.gig.tech](https://bootstrap.gig.tech). - -The Zero-OS Bootstrap Service provides you with the following tools to quickly and easily get you started with **always-up-to-date** builds: - -- [Kernel builds](#kernel-builds) -- [Boot files](#boot-files) - -The actual autobuild service is implemented in the [zero-os/0-autobuilder](https://github.com/zero-os/0-autobuilder) repository, see there for more documentation. - -The build process can be monitored here: [build.gig.tech/monitor/](https://build.gig.tech/monitor/). - - -## Kernel builds - -On the Zero-OS Bootstrap Service home page all available kernel builds (commits) are listed. - -You'll find them in two sections: -- First, under **/latest-release/**, all most recent builds per branch are listed -- And under **/kernel/** all most recent builds are listed - -In both cases the naming notation `g8os-BRANCH-COMMIT.efi` is used. - -E.g. in case of `g8os-1.1.0-alpha-sandbox-cleanup-core0-a2564152.efi`: -- the branch name is `1.1.0-alpha-sandbox-cleanup-core0` -- the commit, or build number is `a2564152` - - -## Boot files - -Next to the most recent kernel builds, the Zero-OS bootstrap service also provides you with all other files to get the kernel booted: - -- [ISO file](#iso) -- [USB image](#usb) -- [iPXE script](#ipxe) -- [UEFI BOOT](#uefi) - - -### ISO - -You can request an ISO file (~2MB) which contains a bootable iPXE service which will download the requested kernel. - -To generate an ISO, just follow this url: `https://bootstrap.gig.tech/iso/BRANCH/ZEROTIER-NETWORK` - -For example, to use the most recent build of the `1.1.0-alpha` branch, with earth's ZeroTier network: `https://bootstrap.gig.tech/iso/1.1.0-alpha/8056c2e21c000001` - -Of course, you can specify a more precise branch (for debugging purposes for instance), e.g.: `https://bootstrap.gig.tech/iso/1.1.0-alpha-changeloglevel-initramfs-035dd483/8056c2e21c000001` - - -### USB - -You can also download an USB image, ready to copy to an USB stick: `https://bootstrap.gig.tech/usb/BRANCH/ZEROTIER-NETWORK` - - -### iPXE Script - -Like for ISO and USB, you can request a iPXE script using: `https://bootstrap.gig.tech/ipxe/BRANCH/ZEROTIER-NETWORK` - -This will provide with you with the script that gets generated for, and embedded in the ISO file and the USB image - -For instance `https://bootstrap.gig.tech/ipxe/zero-os-master/hello/extra%20argument`: -``` -#!ipxe -dhcp -chain https://bootstrap.gig.tech/kernel/zero-os-master.efi zerotier=hello extra argument -``` - -This is useful when you want to boot a remote machine using an iPXE script, i.e. `Packet.net` or `OVH` servers. - - -### UEFI boot from usb - -If you have an UEFI-capable machine that can boot from an USB stick, you can request for an UEFI boot iPXE that has -an iPXE script embedded. - -For instance `https://bootstrap.gig.tech/uefi/zero-os-master/93afae53ef5ae4f0/extra%20argument%20organization=yellowitglobe%20debug=true`: - -The provided image is a few K that can be added into the UEFI partition of the node, or installed on an usb stick: - -Here for linux: - -```bash -# get the UEFI image to boot (note: that is only a bootloader and an ipxe script, so very small) - -FILE=$(mktemp) -wget -O ${FILE} https://bootstrap.gig.tech/uefi/zero-os-master/93afae53ef5ae4f0/extra%20argument%20organization=yellowitglobe%20debug=true -USB="/dev/sdf" -parted -s $USB "mklabel msdos mkpart primary fat32 1 100%" -mkfs.vfat -F32 ${USB}1 -DIR=$(mktemp -d) -mount ${USB}1 $DIR -mkdir -p ${DIR}/EFI/BOOT -cp ${FILE} ${DIR}/EFI/BOOT/BOOTX64.EFI -umount ${DIR} -rm -f ${FILE} -rmdir ${DIR} -``` diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md deleted file mode 100644 index 901cbd2..0000000 --- a/docs/SUMMARY.md +++ /dev/null @@ -1,4 +0,0 @@ -# Summary - -* [Introduction](README.md) -* [Getting Started](gettingstarted/gettingstarted.md) diff --git a/docs/gettingstarted/gettingstarted.md b/docs/gettingstarted/gettingstarted.md deleted file mode 100644 index 8110148..0000000 --- a/docs/gettingstarted/gettingstarted.md +++ /dev/null @@ -1 +0,0 @@ -# Getting Started with Zero-OS Bootstrap Service