archery/README.md

# 'Amelia' is an Arch Linux installer, written in Bash. 

(Shellchecked)

-----------------------------------------------------
The main concept behind this installer is to take full advantage of the extended automation that contemporary linux technologies such as systemd has to offer.

'Amelia' is mainly targeted towards the experienced user that needs a quick installation means.

Yet, it is guided, interactive and intuitive, so that probably everyone can use it.


- ## Automation:

The installer does not support automatic detection of Windows partitions, so if DualBooting is desired, utilize the TUI 'Manual Partitioning' stage to accomplish what you need

Virtual Machines supported: QEMU / Vmware / Virtualbox / HyperV

Also, there is no support (nor will ever be) for non-GPT platforms, as this installer makes absolute use of uEFI's 'Discoverable Partitions Specification'.

Consequently, it will automate the detection of the underlying/involved partitions, perform sanity checks based on your preferences, and auto-mount/auto-activate these partitions when necessary (e.g. swap), without the use of the fstab file.

By using systemd's latest and greatest features, configuration needed for eg. swapping, hibernation etc. is a thing of the past.

The system manager will automatically and more importantly, optimally configure parts of the system, greatly simplifying the installation process and making the final system very robust and of course much more reliable.

In particular, when the 'ext4' filesystem is being selected, the 'genfstab' command is not even executed in the script, and your 'fstab' file will be empty (except only if 'Swapfile' use is desired), as systemd's automation takes care of it.

In the same manner, 'systemd' (instead of busybox: 'base' & 'udev') will be used in your initramfs, as it provides the tools for the said automation.

The installation process completes in "one-go", meaning after it's over and the system has rebooted, you're done.

If there are errors during the installation process, the installer will exit, informing you accordingly and issuing a logfile in the current working directory, stating what went wrong, for troubleshooting purposes.

This logfile will be issued anyway when the installation finishes, stating what was the last action to have taken place by the installer.


- ## Interaction:

There is full interaction with the user.


### Visual interaction:

The installer follows a menu-driven, step-by-step principal, presenting you with a sane sequence of installation steps, aided by colored prompts, making the installation process easy, pleasant and intuitive.


### Input interaction:

You will be asked to make your own choices, and there will always be a confirmation upon success or failure of the outcome.

You will definitely know what has succeded and if anything went wrong.

The installer has been purposely made in such a way that it will exit if unresolvable errors occur, so it ^should be^ impossible to end up with an errored installation or with parts unfinished.

In a few cases, it will try to remedy the situation by taking certain steps (e.g. unmounting a partition, in case it was already mounted from before) and bring you a few steps back, to re-run installation stages that might help you continue with success.

All stages are informative.


# Installer overview:


- ### First Check - Warning: [Auto]

A check/detection takes place, notifying you about the mode the installer runs on, along with the potential hazzard of running as root.

Normally should be runing as root, off the Arch-installation media.
If that's not the case, you will be informed accordingly.

If there is 'terminus-font' detected (already included in the Arch installation media), you will be asked to use this font or its HiDPI version, or you will be prompted to change into tty (and use linux console) if you're just simply test-running the installer in your own system with X or Wayland.

If not, setting different fonts is skipped.


- ### Uefi Mode Verification: [Auto]

Checks if the platform runs in uefi mode, and exits if not.


- ### Internet Connection Check: [Auto]

Pings the Arch servers for connection and exits if none is found.


- ### System Clock Update: [Auto]

Self-explanatory.


- ### Machine Detection: [Auto]

The installer informs the user about the pc-system vendor, model, platform {desktop/laptop/server/vm} and cpu microcode package to be installed later on.


## Main Menu:

- [ ] [1] Personalization
- [ ] [2] System Configuration
- [ ] [3] Disk Management
- [ ] [4] Start Installation

- #### Just select 'Start Installation' and let the installer help you through the installation.

You will experience an 'Assisted Navigation' through all the menus & options and also engage the 'Smart Partitioning' feature.

Saves a lot of time and makes the whole process a breeze !


### Personalization Submenu:

- [ ] [1] Locale & Keyboard Layout Setup
- [ ] [2] User, Root User, Hostname & Shell Setup
- [ ] [ ] Return to Main Menu


### System Configuration Submenu:

- [ ] [1] Kernel, Secureboot Signing, Bootloader & ESP Mountpoint
- [ ] [2] Filesystem & Swap Setup
- [ ] [3] Graphics Setup
- [ ] [4] Desktop Setup
- [ ] [5] EFI Boot Entries Deletion
- [ ] [6] Optimizations
- [ ] [ ] Return to Main Menu


### Disk Management Submenu:

- [ ] [1] Disk GPT Manager
- [ ] [2] Partition Manager
- [ ] [ ] Return to Main Menu

-----------------------------------------------

## Personalization Submenu:


- ### Locale Selection: [Interactive - Skippable]

Set your locale, choose from the locale list or use default.

Skip for Default: en_US.UTF-8


- ### Keyboard Layout Selection: [Interactive - Skippable]

Set your keyboard layout, choose from the keyboard layout list or use default.

Skip for Default: us


- ### User Setup: [Interactive]

Set username, password and verify.


- ### Root User Setup: [Interactive]

Set password and verify.


- ### Hostname Setup: [Interactive]

Self-explanatory.


- ### Shell Selection: [Interactive]

- [ ] [1] Bash
- [ ] [2] Zsh
- [ ] [3] Fish

Select preferred Shell.
Additional packages (eg. auto-completions, auto-suggestions etc. will also be installed)

## System Configuration Submenu:


- ### Kernel Selection: [Interactive]

- [ ] [1] Linux
- [ ] [2] Linux LTS
- [ ] [3] Linux Hardened
- [ ] [4] Linux Zen

Select between the Linux, Linux LTS, Linux Hardened & Linux Zen Kernels.


- ### Secureboot Signing: [Interactive]

Select to sign (or not) all needed binaries for enabling Secure Boot on your system

If Secure Boot is selected, the installer will offer to create a 'Rescue' bootloader entry, especially necessary for UKIs, as editing menu entries under Secureboot is not allowed.

Automatic Secureboot signing for the installed Kernel or UKI will take place in the future.


- ### Bootloader Selection: [Interactive]

- [ ] [1] Systemd-boot
- [ ] [2] Grub

Select between 'Systemd-boot' or 'Grub'.


- ### ESP Mountpoint Selection: [Interactive]

- [ ] [1] Efi
- [ ] [2] Boot

Select between '/efi' or '/boot' as your mountpoint for ESP.


- ### Filesystem Selection: [Interactive]

- [ ] [1] Ext4
- [ ] [2] Btrfs

Select Filesystem to be used (Ext4 / Btrfs).

- If 'Ext4' is selected: 

You will be asked if you'd like a seperate '/home' partition to be created.

Also, a filesystem performance boost will automatically take place by setting the 'fast_commit' option by default when formatting.

- If 'Btrfs' is selected:

You will be asked to label your 'snapshots' directory.

If 'Btrfs' filesystem & 'Grub' bootloader is selected, then the 'grub-btrfs' package will be installed, and the 'grub-btrfsd' service will be automatically enabled for user convenience. 


- ### Swap Selection: [Interactive - Skippable]

- [ ] [1] Swap partition
- [ ] [2] Swapfile
- [ ] [3] Zram Swap
- [ ] [4] None

Select between Swap partition, Swapfile, Zram Swap or none.

If 'Swap Partition' or 'Swapfile' is selected, you'll be asked to set desired 'Swap' size.

Skip if "none" is selected.


- ### Graphics Setup: [Interactive - Skippable]

A check/detection takes place, notifying you about the underlying graphics subsystem.


If Dual/Triple graphics setup is detected, you will be asked to select for which graphics hardware to automatically have drivers installed, hardware acceleration enabled and the graphics subsystem configured (mkinitcpio.conf, kernel parameters etc).


If Virtual-Machine graphics is detected, the setup is skipped, and graphics configuration defaults to 'no'.


If single graphics are detected, you will be offered the choice to automatically have drivers installed, hardware acceleration enabled and the graphics subsystem configured (mkinitcpio.conf, kernel parameters etc).

Notice that only the latest available drivers will be installed, so should you select 'yes' to auto-configure, ensure your graphics subsystem is currently supported.

Xorg DXX drivers (xf86-xxxx-xxxx) for Intel - AMD - Nvidia will NOT be automatically installed.

In case of AMD graphics, 'amdgpu' driver support for 'Southern Islands' and 'Sea Islands' graphics is offered through auto-configuring.

In case of Nvidia graphics and according to the gpu architecture, there's support for both the 'nvidia-open' & 'nvidia' drivers.

Also, support for disabling Nvidia's 'GSP' is offered, when using the 'nvidia' proprietary driver.

When needed, the 'Nvidia Hook' will be automatically created.

Hybrid desktop graphics software (optimus, bumblebee etc) are not offered.


- ### Desktop Setup [Interactive]

In this step, you will be presented with the following list of submenus to choose from:

- [ ] [1] Desktop Selection
- [ ] [2] Arch 'base-devel' Meta-package
- [ ] [3] Web browser Selection
- [ ] [4] Printer & Scanner Support
- [ ] [ ] Return to System Configuration


- #### Desktop Selection [Interactive]

- [ ] [1]  Plasma
- [ ] [2]  Plasma Light  (Amelia's Version)
- [ ] [3]  Gnome
- [ ] [4]  Gnome Light  (Amelia's Version)
- [ ] [5]  Xfce
- [ ] [6]  Cinnamon
- [ ] [7]  Deepin
- [ ] [8]  Budgie
- [ ] [9]  Lxqt
- [ ] [10] Mate
- [ ] [11] Basic Arch Linux (No GUI)
- [ ] [12] Custom Arch Linux
- [ ] [13] Cosmic (ALPHA)

---------------------------------------------------------------

- All desktops offered, except 'Custom Arch Linux', come with network support (networkmanager).

- 'Plasma Light' setup will install a lighter KDE Plasma desktop, ommiting several not essential packages.

- 'Gnome Light' setup will install a lighter Gnome desktop, ommiting several not essential packages.

- 'Basic Arch Linux' is literally a basic Arch linux system, consisting of just the following packages: "base, linux-firmware (only if on bare-metal), sudo, *-ucode, nano, pkgstats, vim, networkmanager, wireless-regdb, e2fsprogs / btrfs-progs (depending on the filesystem selected) and your other current installation preferences/choices.

- 'Custom Arch Linux' consists of the following packages: "base, linux-firmware (only if on bare-metal), sudo, *-ucode, e2fsprogs / btrfs-progs (depending on the filesystem selected) and your other current installation preferences/choices.

In this step you can create your own system on-the-fly, (using a Basic Arch Linux system as base), through the following Menus:

- ##### Custom Arch Linux [Interactive]

- [ ]  Add Your Packages    [Mandatory]
- [ ]  Add Your Services    [Skippable]

---------------------------------------------------------------

- #### Arch 'base-devel' Meta-package [Interactive - Skippable]

The installer asks to install the 'base-devel' package, as it's not part of the 'base' meta-package, which is needed for the majority of use cases.


- #### Web browser Selection [Interactive - Skippable]

- [ ] [1] Firefox
- [ ] [2] Chromium
- [ ] [3] Vivaldi
- [ ] [4] Tor Browser
- [ ] [5] Falkon
- [ ] [6] Qutebrowser

Select one of the available browsers or leave empty to skip.


- #### Printer & Scanner Support [Interactive - Skippable]

Select to install (or not) printer & scanner support software.

A baseline package set will be installed and additional packages will be installed accordingly, if 'Minimal Plasma' or 'Minimal Gnome' has been selected.


----------------------------------------------------------

- ### EFI Boot Entries Deletion: [Interactive - Skippable]

Choose if you wish to delete any EFI boot entries or skip.

If a 'VM' is detected, this stage is skipped.


- ### Optimizations [Interactive - Skippable]

- [ ] [1] Custom Kernel Parameters [Interactive - Skippable]
- [ ] [2] System Watchdogs [Interactive - Skippable]
- [ ] [3] General System Optimizations [Interactive - Skippable]
- [ ] [4] Wireless Regulatory Domain [Interactive - Skippable]
- [ ] [5] Systemd-oomd [Interactive - Skippable]
- [ ] [6] Irqbalance [Interactive - Skippable]
- [ ] [7] Thermald [Interactive - Skippable]
- [ ] [8] Rng-tools [Interactive - Skippable]
- [ ] [9] Rtkit [Interactive - Skippable]
- [ ][10] Tlp [Interactive - Skippable]
- [ ][  ] Return to System Configuration

- 1. The installer offers the convenient option to permanently set your own kernel parameters for boot, on-the-fly.

- 2. The installer asks to disable Watchdogs in the installed system (if not on a critical platform, like a server).

A watchdog is a hardware or software component that keeps track of a system's performance and intervenes if it notices any strange behaviour or malfunctions.

- 3. System optimizations will be set.

Where applicable, system files configuration will take place EXCLUSIVELY in the corresponding drop-in directories and never at the original '.conf' files, so the installed system preserves its functionality across updates and maintenance is minimized.

Type 'v' to get a preview of the affected configuration files.

All optimizations used, derived exclusively from the ArchWiki.

- 4. Enter your 2-letter Country Code (e.g. 'US') to set the correct wifi regulations for your country.

If a 'VM' is detected, this stage is skipped.

- 5. The installer asks to enable the 'systemd-oomd' service, enhancing 'OOM' management which will now be optimally done by the system manager.

'Systemd-oomd' is a system service that uses cgroups-v2 and pressure stall information (PSI) to monitor system and take corrective action before an 'OOM' occurs in the kernel space.

- 6. The installer asks to install & enable 'irqbalance', which is a software that distributes hardware interrupts across processors on a multiprocessor system, in order to increase performance.

- 7. The installer asks to install & enable 'thermald', which is a daemon used to prevent the overheating of platforms.

This daemon monitors temperature and applies compensation using available cooling methods.

- 8. The installer asks to install & enable 'rng-tools', which is a daemon capable of using both environmental noise and hardware random number generators for extracting entropy.

- 9. The installer asks to install & enable 'rtkit' & 'realtime-privileges'.

RealtimeKit is a D-Bus system service that changes the scheduling policy of user processes/threads to SCHED_RR, [Realtime Scheduling Mode on request]

When installing 'realtime-privileges', the current user will also be added to the 'realtime' group.

- 10. The installer asks to install & enable 'tlp'

Tlp is a laptop battery power saving utility for Linux, working out-of-the-box & easy to further configure

## Disk Management Submenu:


- ### Disk GPT Manager: [Interactive - Skippable]

Use 'gdisk' to perform various disk operations to any detected drive in your system (e.g. zapping the GPT and create a new one, etc.)


- ### Partition Manager: [Interactive]

The'Partition Manager' stage consists of 2 Modes:

- #### Automatic Partitioning Mode [consisting of 2 sub-modes]:

- [ ] [1] Smart Mode [Interactive - Skippable]

 This mode engages if the user has selected the 'Assisted Navigation' Installation.
 
 It detects user's preferences and selects a partitioning profile/preset based on these preferences (no additional user interaction needed).
 
 If 'Swap' has been selected, the user is asked to specify desired size.

- [ ] [2] Partitioning Presets [Interactive - Skippable]

This mode offers ready-made file-system compatible Partition Layout Presets with sane defaults to select from.

- #### Manual Partitioning Mode [Interactive - Skippable] :

In this mode the user will manage the involved disk(s) manually, using 'cgdisk' with its easy and intuitive ncurses TUI, making the process of managing the partition table, the partitions, setting GUIDs etc. easy and safe(r).

In addition, it shows extended info about the supported partition types and mountpoints that the installer expects to find.

Existence of an "EFI" System Partition and a "Root x86-64" Partition is mandatory and expected, or else the installation cannot continue.

The partitions layout in this stage should reflect your previous choices, e.g. if you chose to use a 'Swap' partition, and it does not exist, now is the time to create it.

If you need a seperate 'Home' partition, create it now or an existing one can also be used.

For the systemd 'auto-gpt-generator' automation to work, all involved partitions MUST reside in the same physical disk/device.


- ### Installation Disk Selection & Sanity Check: [Auto]

Select a disk to install Arch Linux on.

This step incorporates and performs a Sanity Check on the chosen disk.

This means the installer will verify that the choices you've made so far, are correctly reflected on the partitions layout, before it lets you continue with the installation.

The aim here is to make the installation process error-proof.

It will ensure that an 'EFI' System Partition indeed exists, that a 'Root x86-64' partition exists, that a 'Swap' partition exists IF you chose to use a 'Swap' partition and will also detect an existing seperate 'Home' partition.

If 'systemd-boot' is selected and '/efi' mountpoint for an ESP smaller than 200Mb is selected, the installer expects an 'XBOOTLDR' extended boot partition to be present/user created.

On top of all that, the installer will scan the partitions on the installation disk and if more than one of each type {root/EFI/home/swap/xbootldr} are detected, then it will Auto-Assign the 1st partition of each (involved) type, to be used by systemd's automation in the installation (as the 'Discoverable Partitions Specifications' dictate).
It comes with its own menu/prompts, for proper user interaction.

For convenience, A (TUI) partition/filesystem presentation is presented 
when multiple partitions of the same type {root/EFI/home/swap/xbootldr} have been detected and the user needs to CONFIRM the Automated Selection made by the installer.

If the Sanity Check fails, the installer will smartly load any necessary stages, so you can correct any errors/omissions. 


- ### Encryption Setup: [Interactive - Skippable]

Choose if you will enable LUKS encryption on your 'Swap/Root/Home' partitions

Also, you will be asked to Label your partitions.

Again, the scope here is not to create an inpenetrable system but a decently protected system.

Using 'Secure Boot' with an unencrypted 'EFI System Partition' and a LUKS encrypted 'Root/Home/Swap' partition(s) should suffice.


- ### Swap Partition Activation: [Auto]

If you chose to create a 'Swap' partition, now it will be activated.


# If No Encryption has been selected :

- ### Mode Selection: [Interactive]

The installer asks the user to select the preferred disk preparation mode:

- [ ] 'Auto' will perform Formatting, Labeling and Mounting of all of the involved partitions automatically, but it will ask for your confirmation before formatting a separate ext4 'Home' partition (if found), in case you would like to keep it intact.

- [ ] 'Manual' mode will perform the above by asking the user to select which partitions to format, choose desired name to label the partitions, and mount them accordingly.

The 'Auto' mode will switch to 'Manual' mode if errors are encountered (so the user gets control of the procedure), and when the said mini-step is completed (e.g formatting 'EFI') it will continue in 'Auto' mode for the rest of the partitions.

Upon completion, both 'Auto' and 'Manual' mode present the user with a (TUI) summary of the partitions and mounts layout, preparing for the next step.


- ### Confirm Installation Status [Interactive]

Decide if you will procceed with the installation.

If you are satisfied with the result (presented to you in the previous step and still showing on screen), answer 'yes'.

If your answer is 'no', then the installer unmounts all mounted partitions and reloads 'System Configuration' and all necessary installation stages, so you can revise your choices until you are satisfied with the outcome.


# If LUKS encryption has been selected:

- ### Secure Disk Erasure: [Interactive - Skippable]

Since LUKS encryption has been selected in a previous step, the installer offers the option to securely erase the involved drive before continuing with the installation, if so desired.
After Drive Secure Erasion, the system needs to be rebboted and will do so automatically, after a countdown.
You will have to re-run the installer.


- ### LUKS Encryption: [Interactive - Skippable]

Your selected 'Root x86-64' partition will be encrypted using LUKS.

If a separate 'Home' partition is detected, and the filesystem chosen is 'ext4', then you will be offered the option to encrypt 'Home' too.

Should you choose 'yes' to that option, then auto-configuration will take place, so an extra LUKS password won't be needed to unlock said volume.

Should you choose 'no', the installer will still ask for your confirmation before formatting the 'Home' partition to 'ext4', in case you would like to keep it intact.

This stage cannot offer automatic error-resolving by automatically taking actions such as re-running previous steps of the installation precedure, like [Auto] or [Manual] mode does, as after LUKS encryption has finished, partprobing and informing the kernel about further/new changes requires a system restart.

As a result, if any errors occur at this stage, will eventually terminate the installation, and you will be required to reboot and re-run the installer.

For the same reason, the installer cannot offer the choice of reloading previous phases, as it does in the 'Confirm Installation Status' stage.

# Remaining Installation Process:

- ### Optimize Pacman: [Interactive]

Sometimes, the mirrorlist created from Reflector's auto-run at start-up is not ideal.

So, in this step you can select your preferred country, from the current list of countries that are hosting Archlinux mirrors.

If the field is left empty, the default Reflector's mirrorlist will be used.

If a country from the list is chosen, Reflector will rate its mirrors, using [ l 10 -p https -f 10 ].
If no mirrors are found, it means that the country chosen doesn't fulfill Reflector's set criteria.
Try with another country.

Next, you will be asked to enable Pacman's 'Multilib' repository in the installed system, if desired.

- ### Pacstrap System: [Auto]

The system will be pacstrapped and your selected setup will be installed.


- ### Chroot & Configure System: [Auto]

During this stage, the majority of configuration takes place.

Detection of rotational or solid state drives has already taken place, so 'fstrim.timer' will be activated accordingly for the installation drive.

Also, if a non-rotational drive is being used during installation and LUKS encryption has been selected, then specific options will be applied to open the LUKS container.

Graphics setup, encryption setup, swap/swapfile/Zram Swap activation, swap offset calculation, specific filesystem-based options, pciid database update, auto configuration of your timezone based on your computer's ip address, sudoers file configuration, systemd services activation etc., all happen here.

As mentioned earlier, all configuration takes place ONLY in the respective drop-in directories and never at the original '.conf' files, where applicable.





That's pretty much it.

All instructions used, stem from the Arch wiki.

Any feedback will be greatly appreciated.