X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=f7e6ef1a3727ff56c13b7e101d398282d1741159;hb=1a5548031efc4a1fa88ca94237eac3033cf97ef1;hp=f9137a04dd0617c07a9dd3f9777639b6fead7b3b;hpb=a43d3eec943c5f0491b300214a3c744d31a6e542;p=automated-distro-installer

diff --git a/README b/README
index f9137a0..f7e6ef1 100644
--- a/README
+++ b/README
@@ -1,4 +1,40 @@
-Scripts for initial setup of OSes on my home network.
+Scripts for provisioning OSes on my home network.
 
-My network is a wndr3700v2 router with openwrt on it and a few pcs
-with various gnu/linux distros on them.
+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.  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.
+
+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
+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.