add docker group, small docs update

[automated-distro-installer] / README

diff --git a/README b/README
index 5e09791e75d4c320ecb0a752f7090c9fa8e6a475..f939a7d795295506aa6547832f4ab3a051607fe4 100644 (file)
--- 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
 
 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


@@ -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
 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.
 
 It also automates configuration of an openwrt router after manual
 initial installation.


@@ -44,26 +45,40 @@ Some of the scripts have dependencies for some simple obvious utility
 scripts from https://iankelling.org/git, and of course there are some
 hostnames that are specific to my network.
 
 scripts from https://iankelling.org/git, and of course there are some
 hostnames that are specific to my network.
 

-Main scripts meant to be called interactively:
+All scripts meant to be used directly are listed here:

 
 

-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
+
+# Scripts to setup the environment for the install
+
+arch-pxe # Setup arch pxe boot server from an arch base image

 fai-redep # Deploy fai configuration to host "faiserver"
 fai-redep # Deploy fai configuration to host "faiserver"

-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-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
 faiserver-uninstall # uninstall fai-server
 faiserver-setup # install fai-server on the current machine

+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
+
+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 this or a remote machine using host faiserver
+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
+
+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 # 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
 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
-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