X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=72669bb4658496a349cd4a30f66dcf280e2cd3d8;hb=d29d21017de635db1d05769144db56f44addd055;hp=fa28fa97944cc5e1d8bbff0b7848920e4eee865a;hpb=7386cdbee20dd73095264e2ad0ead433f97ac946;p=automated-distro-installer

diff --git a/README b/README
index fa28fa9..72669bb 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-Multi-boot/distro btrfs provisioning
+PXE install w multi-boot, btrfs & Libreboot support
 
 Some things are specific to my home network, and uses files with secrets
 that are not in this repo. Uses pxe or pxe-kexec (on libreboot, I have
@@ -6,7 +6,7 @@ not added a pxe rom, I use a minimal debian stable subvolume which acts
 like a pxe rom). I use this for bare metal and vms, and two scripts
 which can run post boot so I use them on vps distributed image as well.
 
-Features people may find useful: installs encrypted trisquel belanos, ,
+Features people may find useful: installs encrypted trisquel belenos, ,
 debian jessie, debian stretch, ubuntu 16.04, and arch (havne't done
 recently, probably a bit broken), in a multi-boot setup using multiple
 subvolumes of a single btrfs filesystem.  Utilizes multiple disks, with
@@ -25,7 +25,8 @@ People who use fai may find these things as useful examples: it uses
 dnsmasq (on a openwrt machine) for dhcp instead of the isc
 dhcp. fai-wrapper is a small script to use basic fai classes outside of
 fai. It does not use the fai partitioning tool, but the script is
-inspired from it and works outside of fai.
+inspired from it and works outside of fai. It supports running a fai
+server on debian within android via Maru.
 
 It also automates configuration of an openwrt router after manual
 initial installation.
@@ -54,19 +55,23 @@ fai-redep # Deploy fai configuration to host "faiserver"
 faiserver-revm # using pxe & preseed, create a vm which is a fai server
 faiserver-uninstall # uninstall fai-server
 faiserver-setup # install fai-server on the current machine
-myfai-chboot # setup fai server for kexec, for use instead of "pxe-server"
-pxe-server # disable/enable fai or arch pxe boot server
+myfai-chboot # setup fai tftp and nfs. useful with pxe-kexec
+pxe-server # disable/enable pxe dhcp, tfp, and nfs
 wrt-setup-remote  # setup my router in general: dhcp, dns, etc.
 
 
-# Scripts to do a distro install
+# Script to do a distro install
 
-arch-init-remote # install arch (after it's been booted into it's setup env)
 dsfull # install & post-install a new fai distro
-fai-kexec # kexec to fai tftp server that pxe would normally point to
+arch-init-remote # install arch after it's been booted into it's setup env
+fai-kexec # Kexec this or a remote machine using host faiserver
+live-kexec # fai kexec from upstream live cds, e.g. curl live-kexec|bash
+
+
+# Test scripts
+
 arch-revm # test arch install on a fresh vm
 fai-revm  # test fai install on a fresh vm
-live-kexec # fai kexec from upstream live cds, e.g. curl live-kexec|bash
 
 
 # Scripts to call after a distro install for various reasons
@@ -74,12 +79,13 @@ live-kexec # fai kexec from upstream live cds, e.g. curl live-kexec|bash
 chboot # Set grub to boot into a different distro (installed earlier)
 install-chboot # reinstall chboot to /boot subvols, for chboot updates.
 eboot # reboot without automatic disk decryption
-fai-wrapper # Evaluate and use fai classes outside of fai.
+fai-wrapper # use fai classes outside of fai. sourced, not called.
+faiserver-disable # Disable the fai nfs server exports
 fresize # resize swap or boot partitions in a host
 
 
 License stuff:
-The license for the project is GPLv2 or later, mostly because fai is
-and I periodically rebase off their example setup for debian. Also,
-there is a modified encrypt.upstream, which is from the cryptsetup
-package in arch, which is under the same license.
+The license for the project is GPLv2 or later, mostly because fai is and
+I periodically rebase off their example config, which contains small
+scripts. Also, there is a modified encrypt.upstream, which is from the
+cryptsetup package in arch, which is under the same license.