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