Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 38 insertions, 9 deletions
diff --git a/README.md b/README.md
index 3f7d24ad..2c9cf019 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,44 @@
# archinstall
Just a bare bone automated [Arch](https://wiki.archlinux.org/index.php/Arch_Linux) install with network deployment instructions based on MAC-address.
-# Autorun on Arch Live CD
+# Autorun on Arch Live CD (Unattended install)
# cd ~/archlive
# echo -e "git\npython-psutil" >> packages.both
- # echo "cd /root" >> ./airootfs/root/customize_airootfs.sh
- # echo "git clone https://github.com/Torxed/archinstall.git" >> ./airootfs/root/customize_airootfs.sh
- # echo "chmod +x ~/archinstall/archinstall.py" >> ./airootfs/root/customize_airootfs.sh
+ # cat <<EOF >> ./airootfs/root/customize_airootfs.sh
+ cd /root
+ git clone https://github.com/Torxed/archinstall.git
+ chmod +x ~/archinstall/archinstall.py
+ EOF
# mkdir ./airootfs/etc/skel
- # echo '[[ -z $DISPLAY && $XDG_VTNR -eq 1 ]] && sh -c ~/archinstall/archinstall.py' >> ./airootfs/etc/skel/.zprofile
+ # echo '[[ -z $DISPLAY && $XDG_VTNR -eq 1 ]] && sh -c "~/archinstall/archinstall.py"' >> ./airootfs/etc/skel/.zprofile
# rm -v work*; ./build.sh -v
> Note: `~/archlive` might be different on your system, see [ArchISO#Setup](https://wiki.archlinux.org/index.php/archiso#Setup) for more info.
-Whenever this live-cd boots, from here on now - it'll run `archinstall.py` with the `net-deploy` branch.
+Whenever this live-cd boots, from here on now - it'll run `archinstall.py` and attempt to unattendely install a default Arch Linux base OS with `base base-devel` as packages.
+Or - if successfull - a profile was found at [/deployments](https://github.com/Torxed/archinstall/tree/master/deployments) for the machine being installed (MAC-address based lookup).
-> CAUTION: If no parameters are given, it will devour the first disk in your system (/dev/sda, /dev/nvme0n1 etc).
+> CAUTION: If no parameters are given, **it will devour the first disk in your system** (/dev/sda, /dev/nvme0n1 etc).
+
+## Autorun on Arch Live CD (User specified profile)
+
+Everything in the steps above are the same, except for one line that needs to change:
+
+ # echo '[[ -z $DISPLAY && $XDG_VTNR -eq 1 ]] && sh -c "~/archinstall/archinstall.py --no-default"' >> ./airootfs/etc/skel/.zprofile
+
+This will cause the script to halt and ask for a profile to install before proceeding.
+When asked, enter `workstation` for instance - to install based on the workstation template.
+
+> CAUTION: Even if `--no-default` is given, if a MAC-address matches under `/deployments`, that profile will forcefully be installed.
+
+## Autorun on Arch Live CD (With custom webserver for deployment profiles)
+
+Again, one line differs from the unattended install, change the following line:
+
+ # echo '[[ -z $DISPLAY && $XDG_VTNR -eq 1 ]] && sh -c "~/archinstall/archinstall.py --profiles-path=http://example.com/profiles"' >> ./airootfs/etc/skel/.zprofile
+
+This will cause the script to look at `http://example.com/profiles/<mac>.json` for instructions.
# Manually run it on a booted Live CD
@@ -27,7 +49,7 @@ Whenever this live-cd boots, from here on now - it'll run `archinstall.py` with
# umount -R /mnt; cryptsetup close /dev/mapper/luksdev
# python3 ./archinstall/archinstall.py
-> Note: This assumes `--post=stay` is set to avoid instant reboot at the end.
+> Note: This assumes `--post=stay` is set to avoid instant reboot at the end or if during any time a user pressed `Ctrl-C` and aborted the installation.
# Some parameters you can give it
@@ -63,7 +85,14 @@ Whenever this live-cd boots, from here on now - it'll run `archinstall.py` with
--post=reboot (Default)
After a successful install, reboots into the system. Use --post=stay to not reboot.
-net-deployment structs support all these and more, among those, custom arguments with string formatting.
+ --no-default
+ This parameter causes the installation script to halt if no MAC-based profile was found under /deployments
+
+ --profiles-path=https://example.com/profiles
+ Changes the default path the script looks for deployment profiles.
+ The default path is 'https://raw.githubusercontent.com/Torxed/archinstall/master/deployments'
+
+Deployment profile structs support all the above parameters and more, for instance, custom arguments with string formatting.
See [deployments/workstation.json](https://github.com/Torxed/archinstall/blob/net-deploy/deployments/workstation.json) for examples.
## End note