minor doc update
[automated-distro-installer] / README
1 Multi boot/distro bare metal provisioning
2
3 Some things are specific to my home network. Also provisions vms.
4
5 Features people may find useful: installs encrypted arch, debian stable,
6 & debian testing all on the same btrfs filesystem, smartly utilizing
7 multiple disks, with scripts to automatically decrypt on reboots. Other
8 debian based distros should work fine, and I'm planning to add Fedora
9 support. Disks are grouped as ssd or hdd and raided in raid 1 or raid 0
10 per configuration. The os raid is partitioned into boot, swap, and root,
11 (only boot is unencrypted) and there are scripts to resize those
12 partitions post-install if needed.
13
14 It also fully automates configuration of an openwrt router after manual
15 initial installation.
16
17 My network is a wndr3700v2 router with openwrt on it and a few pcs/laptops.
18
19 Since fai requires a debian server as the fai server, there are also
20 scripts to automate a debian install using pxe and preseeding, which can
21 be done from any distro.
22
23 Some of the scripts have dependencies for some simple obvious utility
24 scripts from https://iankelling.org/git, and of course there are some
25 hostnames that are specific to my network.
26
27 Main scripts meant to be called interactively:
28
29 arch-init-remote # install arch (after it's been booted into it's setup env)
30 chboot # Set grub to boot into a different distro (installed earlier)
31 dsfull # install & setup a new fai distro (if data partition already synced)
32 fai-revm # test fai on a fresh vm
33 faiserver-revm # create a vm which is a fai server
34 faiserver-uninstall
35 fresize # resize swap or boot partitions in a host
36 pxe-server # temporarily enable (usually) fai or arch boot server
37 wrt-setup-remote # setup my router
38
39 License stuff:
40 The license for the project is GPLv2 or later, mostly because fai is
41 and I periodically rebase off their example setup for debian. Also,
42 there is a modified encrypt.upstream, which is from the cryptsetup
43 package in arch, which is under the same license.