X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=b53550723c17c7fe98bb6ca670b9dfa6bb97fe5c;hb=23bf2f3666becf9d3c219af1eaea08b4cf843492;hp=309d5ff12634e583c17ec05d885b0caec844e0b2;hpb=896f57cc86a9babea7bdb2bf39d95ba2c77beca6;p=automated-distro-installer

diff --git a/README b/README
index 309d5ff..b535507 100644
--- a/README
+++ b/README
@@ -1,22 +1,55 @@
-Scripts for initial setup of OSes on my home network.
+Multi-boot/distro btrfs 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. Uses PXE, designed for bare
+metal but also works for pxe booted VM.
 
+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. The
+partititioning and filesystem script is the biggest part and is at
+fai/config/hooks/partition.DEFAULT. 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 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.
 
-Scripts meant to be called interactively:
+The repo name fai is copied from a project of the same name which this
+project uses for debian installs. It stands for "fully automated
+installer."
 
+It also fully automates configuration of an openwrt router after manual
+initial installation.
+
+Provisionining is done, I sync files using unison, 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
+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 distro (if data partition already synced)
+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
+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
 pxe-server # temporarily enable (usually) fai or arch boot server
 wrt-setup-remote  # setup my router
 
-
-  PID USER      PR  NI    VIRT    RES    SHR S  %CPU %MEM     TIME+ COMMAND
-24412 nobody    30  10 33.209g 0.014t   1192 R  96.0 91.2  45:27.66 find
\ No newline at end of file
+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.