X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=125d5d4f2f3abb94710debc0291309e08bf5bf88;hb=dff5d53b917601ff9f0d66a2aed397a9deb1d61e;hp=e1ceffd987b647fcf74a4e7121d958f84738194a;hpb=2e975979fa5bad84f3d2a84a9d62fbfd8793374c;p=automated-distro-installer

diff --git a/README b/README
index e1ceffd..125d5d4 100644
--- a/README
+++ b/README
@@ -1,16 +1,43 @@
-Scripts for initial setup of OSes on my home network.
+Multi boot/distro bare metal provisioning
 
-My network is a wndr3700v2 router with openwrt on it and a few pcs
-with various gnu/linux distros on them.
+Some things are specific to my home network. Also provisions vms.
 
+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
+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.
 
-Scripts meant to be called interactively:
+It also fully automates configuration of an openwrt router after manual
+initial installation.
 
+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
+scripts to automate a debian install using pxe and preseeding, which can
+be done from any distro.
+
+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.
+
+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)
+dsfull # install & setup a new fai distro (if data partition already synced)
 fai-revm  # test fai on a fresh vm
 faiserver-revm # create a vm which is a fai server
 faiserver-uninstall
-fresize # resize swap or boot partitions in a host created with my fai setup
+fresize # resize swap or boot partitions in a host
 pxe-server # temporarily enable (usually) fai or arch boot server
 wrt-setup-remote  # setup my router
+
+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.