Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jnsgruk/architect

Simple Arch Linux bootstrap project
https://github.com/jnsgruk/architect

arch archlinux automation bash installer jnsgruk script

Last synced: about 1 month ago
JSON representation

Simple Arch Linux bootstrap project

Awesome Lists containing this project

README 

        
## Architect



> Yet-Another-Arch-Installer



This project not finished, but currently a simple set of shell scripts/templated files to bootstrap an Arch Linux system. It is fairly minimal, and quite opinionated.



My primary use case for this is building my own machines, but also quickly building virtual machines with different configs for testing new desktop releases etc. I tend to use libvirt and virt-manager, so any VM detection is based on that assumption.



By default, the script will:



- Partition a disk (ext4 or btrfs, optionally encrypted with LVM-on-LUKS)

- Install a few basic packages

- Install and configure `systemd-boot` (UEFI systems) or `grub` (BIOS systems)

- Configure locale/timezone/keyboard layout

- Detect requirement for, and if necessary install microcode packages

- Create a non-root user and enable `sudo` access

- Install and enable NetworkManager

- Install [yay](https://github.com/Jguer/yay)

- Install a Desktop Environment (Gnome, Plasma, XFCE or Mate)

- Install and configure Plymouth with flicker-free boot



## Getting Started



To use this script, boot into the Arch ISO and run:



```bash

# Download the stage1.sh script

$ curl -sLo architect.sh https://jnsgr.uk/architect

# Install using defaults

$ /bin/bash architect.sh

```



To install with other configuration files or presets:



```bash

# Install using config file downloaded to live ISO environment

$ /bin/bash architect.sh /path/to/config.yml



# Install using config file available at a URL

$ /bin/bash architect.sh https://somedomain.com/your_config.yml

```



With no arguments, the installer will use the [default preset](./presets/default.yml). Default values are:



```yml

---

hostname: archie

username: user



regional:

  locale: en_GB.UTF-8

  timezone: Europe/London

  keymap: uk



partitioning:

  disk: /dev/vda

  # Choose either ext4 or btrfs

  filesystem: btrfs

  # If set to true, disk is encrypted with LVM-on-LUKS

  encrypted: false

  # Swapfile size in MiB. Set to zero to disable swap

  swap: 1024



provisioning:

  # Desktop environment. Options: none, gnome, plasma, xfce, mate

  desktop: gnome

  # Install appropriate desktop extras like gnome-extra, kde-applications, xfce4-goodies

  desktop-extras: true

  # Choose to install the Plymouth boot-splash

  plymouth: true

  # Install a collection of extra fonts for the desktop

  fonts: true

  # Install bluetooth and bluetooth audio support

  bluetooth: true

  # List of packages to install

  packages:

    - git

    - base-devel



architect:

  # Choose the branch of Architect to clone during install

  branch: master

  # Option to disable the provisioning stage

  disable_stage3: false

  # Enable "set -x" in scripts for debugging

  debug: false

  # Unmount drives and reboot after install

  reboot: true

```



It is possible to specify a smaller config file to just override specific values in the defaults, for example:



```yml

---

username: bob

hostname: archbox

```



## Install Stages Description



### Stage 1



Stage 1 is the pre-chroot setup. It includes the following:



- Keyboard layout setup

- Partitioning and disk encryption if enabled

- Mounting new filesystem under `/mnt`

- Running `pacstrap` to install base packages into new filesystem

- Runs `arch-chroot` and invokes stage 2



### Stage 2



Stage 2 happens inside the `chroot` environment. It includes the following:



- Setup locale

- Set hostname

- Configure and generate `initramfs`

- Install processor microcode if required

- Configure a swapfile

- Install and configure bootloader

- Change root password

- Create a non-root user

- Configure `sudo` for non-root user

- Invoke stage 3 if enabled



Once stage 2 is complete, the bare minimum install is complete. You can disable stage 3, reboot and enjoy your very minimal Arch Linux setup.



### Stage 3



Stage 3 aims to raise the install from "minimum viable arch" to a more usable system:



- Install more packages

- Install and configure the `yay` AUR helper

- Install and configure a desktop environment (Gnome, Plasma, XFCE or Mate)

- Install and configure Plymouth



## TODO/Contributing



I'm planning to keep this project relatively minimal, but will consider adding features if requested through Github Issues or otherwise. Feel free to submit pull requests!



Currently planned features...



- [ ] Add option to provide URL to post-provision script

- [x] Install a sane set of fonts, cursors, themes, etc. if desktop if specified

- [x] Configure bluetooth and audio properly if desktop specified

- [x] Install and configure Plymouth with flicker-free boot

- Configure TRIM properly if on a supported SSD

  - [x] Detect SSD and TRIM support

  - [x] Enable the `fstrim` weekly timer

- Update disk partitioning to include:

  - [x] btrfs

  - [x] LVM/LUKS with btrfs

  - [x] LVM/LUKS with ext4

- Presets for desktop environments:

  - [x] Configure/detect display drivers

  - [x] Gnome

  - [x] Plasma

  - [x] XFCE

  - [x] MATE

- [x] Migrate to `systemd` hooks in `mkinitcpio`?

- [x] Configure a less ugly lightdm greeter and sddm theme

- [x] Configure a swapfile

- [x] Non-EFI bootloader install with GRUB

- [x] Enable option settings with a JSON/YAML file

- [x] Enable customisation of installed packages

- [x] Install and configure `yay`