little bette readme
[automated-distro-installer] / README
diff --git a/README b/README
index b7bfa78746e19e68d69076b90b4abb8f423ef67f..10d52fed129df56318d0a98600007528941ad1a1 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,19 @@
 Multi-boot/distro btrfs provisioning
 
-Some things are specific to my home network. Uses pxe or pxe-kexec (for
-systems like libreboot with no pxe rom, we boot into a live cd or distro
-for bootsraping). Works for bare-metal or vms.
-
-Features people may find useful: installs encrypted trisquel belanos,
-arch, debian stable, & debian testing all on the same btrfs filesystem.
-Smartly utilizes multiple disks, with scripts to automatically decrypt
-on reboots. The partititioning and filesystem script is at
+Some things are specific to my home network. Uses pxe or pxe-kexec (on
+libreboot, I have not addded 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, ,
+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
+scripts to automatically decrypt on intentional reboots, but not after
+shutdown or power loss.
+
+The partititioning and filesystem script is at
 fai/config/hooks/partition.DEFAULT. Other debian based distros at least
 as new as ubuntu 14.04 should work fine, and I'm planning to add Fedora
 support. Disks are grouped as ssd or hdd and raided in raid 1 or raid 0
@@ -15,14 +21,17 @@ per configuration. The base partitions are divided into boot, swap, and
 root, (only boot is unencrypted). There are scripts to resize those
 partitions post-provision and while the system is running.
 
-The repo name fai is copied from the debian project of the same name,
-meaning "fully automated installer."
+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.
 
-It also fully automates configuration of an openwrt router after manual
+It also automates configuration of an openwrt router after manual
 initial installation.
 
-After provisionining is done, I sync files using unison, then automate
-further setup using a different set of scripts,
+After provisionining is done, I sync files using btrfs, or unison for
+vps, then automate further setup using a different set of scripts,
 https://iankelling.org/git/?p=distro-setup;a=tree.
 
 My network is a wndr3700v2 router with openwrt on it and a few pcs/laptops.
@@ -39,12 +48,17 @@ Main scripts meant to be called interactively:
 
 arch-init-remote # install arch (after it's been booted into it's setup env)
 chboot # Set grub to boot into a different distro (installed earlier)
+install-chboot # reinstall chboot to /boot subvols, for when it changes
 dsfull # install & setup a new fai distro (if data partition already synced)
+eboot # reboot without automatic disk decryption
+fai-kexec # kexec to fai tftp server that pxe would normally point to
 fai-revm  # test fai on a fresh vm
+fai-wrapper # Evaluate and use fai classes outside of fai.
 faiserver-revm # create a vm which is a fai server using pxe & preseed file
 faiserver-uninstall # uninstall fai-server
 faiserver-setup # install fai-server on the current machine
 fresize # resize swap or boot partitions in a host
+myfai-chboot # Sets up tftp pxe config on fai server
 pxe-server # temporarily enable (usually) fai or arch boot server
 wrt-setup-remote  # setup my router
 ubuntu-xenial-live-fai-kexec # do fai install from xenial live cd using kexec