ObsidianOS Installation Guide

Before You Begin

Check the System Requirements.

Step 1: Choose Your Installation Method

You have two options:

Option 1: Recommended — Use the Customized ArchISO

Download a pre-built ArchISO from the ObsidianOS Download Page, or build your own with:
```
git clone https://github.com/Obsidian-OS/archiso/
cd archiso
git submodule update --init --recursive
sudo make -B
```
- The created ISO is in the out directory.
The customized ArchISO provides both obsidianctl and mkobsidiansfs tools out of the box.
This is the recommended and easiest way to install ObsidianOS.

Option 2: Use an Existing Arch Linux Host

Install the arch-install-scripts package on your Arch system.
Manually build and install obsidianctl (or use AUR) and mkobsidiansfs.
Proceed with OS image creation and installation using those tools.

Step 2: Prepare the Target Drive

Warning: This will erase the target drive.

Identify your target disk:
```
lsblk
```
Format the drive (for temporary build environments on ArchISO):
```
mkfs.ext4 /dev/sdX
```
- Replace /dev/sdX with your target disk (not a partition!).
Mount the formatted drive:
```
mount /dev/sdX /mnt
```

Step 3: Create a System Image

Configure my.mkobsfs for your needs:
- Example config includes build directory, package list, user settings, and optional dotfiles arrangement.
Build the SquashFS image:
```
mkobsidiansfs my.mkobsfs
```

Step 4: Install the OS Image

Check available drives:
```
lsblk
```
Install the image:
```
obsidianctl install /dev/sdX /etc/system.sfs
```
- Replace /dev/sdX with the target drive and adjust /etc/system.sfs as needed. also inputting a .mkobsfs file instead of the SquashFS image is supported.

Step 5: Reboot

When finished, reboot your system. You now have a functional ObsidianOS installation.

More info

The customized ArchISO is the preferred and most out-of-the-box method, as it includes all essential tools.
For advanced users, building from a regular Arch host remains fully supported.