diff options
| -rw-r--r-- | README | 68 | ||||
| -rw-r--r-- | README.org | 60 |
2 files changed, 60 insertions, 68 deletions
@@ -1,68 +0,0 @@ -====================================================== -Installs Artix Linux with LUKS Root Encryption & BTRFS -====================================================== - -IMPORTANT: -Script is working on UEFI but not BIOS at the moment. - -USAGE: -1. Configure DRIVE & other options in script -2. boot up an Artix Linux live ISO installation -3. login as 'root' with password 'artix' -4. get the installation script onto the system -5. execute script - -NOTES: -- DECRYPTION password is set via installation -- default 'root' password is 'artix' -- USER password is the same as the DECRYPTION password - -EXAMPLE SYSTEM LAYOUT: -+---------------------------------------------------+ -| Device | Label | Mount | Size | -|---------------------------------------------------| -| /dev/sda | | | | -| ├─/dev/sda1 | BOOT | /boot | 512M | -| ├─/dev/sda2 | SWAP | [SWAP] | 16G | -| └─/dev/sda3 | LUKS | | MAX | -| └─/dev/mapper/root | ROOT | | | -| └─@ | | / | | -| └─@home | | /home | | -| └─@snapshots | | /.snapshots | | -+---------------------------------------------------+ - -CONFIGURATION: -- drive: the drive to perform the installation -- boot: the boot partition -- swap: the swap partition -- root: the root partition - -- swap_size: defaults to auto, but can be overwritten - e.g: 'swap_size=8G'. - -- boot_size: defaults to 512M. - Set 512M or more if duel-booting; e.g: 'boot_size=1G'. - -- timezone: a timezone (defined in '/usr/share/zoneinfo/'). -- locale: a locale (defined in '/etc/locale.gen'). -- user: the main user of the system. -- user_groups: the groups 'user' belongs to. -- hostname: the hostname of the system. - -- encrypt: whether or not to encrypt the drive - -- arch_support: whether to enable Arch repositories. - (enables extra & multilib) - -- enable_aur: specifies whether to install an AUR helper. - (installs trizen AUR helper) - -- autologin: automatically login to user after unlocking drive. - User password must match decryption password; this is - the default behaviour when installing, however if you - update your password be sure to update the decryption - password to match, or remove '--autologin USER' from - '/etc/runit/sv/agetty-tty1/conf' to disable this behaviour. - -NOTES -Last tested using 'artix-base-runit-20230814-x86_64.iso' on UEFI
\ No newline at end of file diff --git a/README.org b/README.org new file mode 100644 index 0000000..e2eda08 --- /dev/null +++ b/README.org @@ -0,0 +1,60 @@ +#+title: Artix Linux Installation +#+options: num:nil + +* Introduction +The installation script provides an [[https://artixlinux.org][Artix Linux]] distribution with BTRFS and minimal packages. +Follow the setup process bellow to install it onto a system. + +* Setup +1. boot up a system with an [[https://artixlinux.org/download.php][Artix Linux ISO]] (it must be a dinit base image) +2. login as =root= with password =artix= +3. ensure system is connected to the internet +4. download git & a text editor (e.g. =pacman -Syy git nano=) +5. clone this repository onto the system +6. configure options in the =config= file +7. run =install.sh= to begin installation + +* Notes +- default root password is =artix= +- decryption password is the =user= password +- UEFI is supported but not BIOS at the moment + +* Example System Layout +#+begin_example + +--------------------------------------------------+ + | Device | Label | Mount | Size | + |--------------------------------------------------| + | /dev/sda | | | | + | ├─/dev/sda1 | BOOT | /boot | 512M | + | └─/dev/sda2 | ROOT | | MAX | + | └─@ | | / | | + | └─@home | | /home | | + | └─@tmp | | /tmp | | + | └─@var | | /var | | + | └─@snapshots | | /.snapshots | | + | └─@swap | SWAP | /.swap | AUTO | + +--------------------------------------------------+ +#+end_example + +* Configuration Options +Configuration options are available in the =config= file. + +| Option | Example | Notes | +|--------------+----------------+--------------------------------------------------| +| =drive= | /dev/sda | main device for installation | +| =boot= | /dev/sda1 | can be already in use if =duel_boot= is enabled | +| =root= | /dev/sda2 | will use BTRFS with dedicated subvolumes | +| =swap_size= | auto | can be set explicitly, e.g. =8G= or =16G= | +| =boot_size= | 512M | set a large value if duel booting, e.g. =1G= | +| =duel_boot= | true | =boot= must be already setup & separate from =drive= | +| =timezone= | Europe/London | timezones are defined in =/usr/share/zoneinfo/= | +| =locale= | en_GB | locales are defined in =/etc/locale.gen= | +| =user= | blake | the main user of the system | +| =user_groups= | wheel,log,seat | groups for =user=, see [[https://wiki.archlinux.org/title/Users_and_groups#Group_list][ArchWiki]] for more info | +| =hostname= | ArtixPC | the system name | +| =arch_support= | false | enables extra & multilib repositories | +| =enable_aur= | false | installs the =trizen= AUR helper | +| =autologin= | false | automatically login system | + +* Notes +Last tested using =artix-base-dinit-20240823-x86_64.iso= on a UEFI system. |