improve docs

[automated-distro-installer] / README

diff --git a/README b/README
index 125d5d4f2f3abb94710debc0291309e08bf5bf88..157bb783391e522af3eaa7210d911568a1339e5f 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +1,36 @@
-Multi boot/distro bare metal provisioning
+Multi-boot/distro btrfs provisioning

 
 

-Some things are specific to my home network. Also provisions vms.
+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 arch, debian stable,
-& debian testing all on the same btrfs filesystem, smartly utilizing
-multiple disks, with scripts to automatically decrypt on reboots. Other
-debian based distros should work fine, and I'm planning to add Fedora
+Features people may find useful: installs encrypted trisquel belanos,
+arch (havne't done recently, probably a bit broken), debian stable, &
+debian testing which all share the same btrfs filesystem.  Smartly
+utilizes multiple disks, with scripts to automatically decrypt on
+reboots. 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
 support. Disks are grouped as ssd or hdd and raided in raid 1 or raid 0

-per configuration. The os raid is partitioned into boot, swap, and root,
-(only boot is unencrypted) and there are scripts to resize those
-partitions post-install if needed.
+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 copied from the project of the same name because it
+uses it for debian based installs. People who are familiar with fai may
+find these things usefull: it uses dnsmasq (on a openwrt machine) for
+dhcp instead of the isc dhcp server. fai-wrapper is a small script to
+use basic fai classes outside of fai.

 
 It also fully automates configuration of an openwrt router after manual
 initial installation.
 
 
 It also fully automates configuration of an openwrt router after manual
 initial installation.
 

+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.
 
 Since fai requires a debian server as the fai server, there are also
 My network is a wndr3700v2 router with openwrt on it and a few pcs/laptops.
 
 Since fai requires a debian server as the fai server, there are also


@@ -28,13 +45,21 @@ 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)
 
 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)
 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-revm  # test fai on a fresh vm

-faiserver-revm # create a vm which is a fai server
-faiserver-uninstall
+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
 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
 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
+myfai-chboot # use instead of pxe-server for fai kexec based install

 
 License stuff:
 The license for the project is GPLv2 or later, mostly because fai is
 
 License stuff:
 The license for the project is GPLv2 or later, mostly because fai is