summaryrefslogtreecommitdiff
path: root/README.org
blob: fc00c0028917f0837ab3e1d76d904d7bdc734f8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#+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                                      |
| =elogind=      | true           | if false, [[https://sr.ht/~kennylevinsen/seatd/][seatd]] and [[https://github.com/chimera-linux/turnstile][turnstile]] is used                           |
| =greeter=      | greetd         | enables greetd with [[https://github.com/apognu/tuigreet][tuigreet]] or the default =agetty= login prompt |

* Notes
Last tested using =artix-base-dinit-20240823-x86_64.iso= on a UEFI system.