Dotfiles/docs/html/installation.html

502 lines
18 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation — M-Archy Dotfiles</title>
<style>
/* ── CyberQueer Theme ──────────────────────────────────────────────── */
:root {
--bg: #1A1A1A;
--bg2: #242424;
--bg3: #2e2e2e;
--text: #D6ABAB;
--accent: #E40046;
--violet: #5018DD;
--danger: #F50505;
--border: #5018DD;
--radius: 10px;
--radius-sm: 5px;
}
/* ── Reset & Base ──────────────────────────────────────────────────── */
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
html { scroll-behavior: smooth; }
body {
background-color: var(--bg);
color: var(--text);
font-family: 'Agave Nerd Font Mono', 'JetBrains Mono', 'Fira Code',
'Cascadia Code', 'Source Code Pro', monospace;
font-size: 15px;
line-height: 1.75;
max-width: 960px;
margin: 0 auto;
padding: 2.5rem 2rem 5rem;
}
/* ── Typography ────────────────────────────────────────────────────── */
h1, h2, h3, h4, h5, h6 {
font-family: 'Agave Nerd Font Mono', monospace;
font-weight: 700;
line-height: 1.25;
margin-top: 2.2rem;
margin-bottom: 0.6rem;
}
h1 {
color: var(--accent);
font-size: 2.2rem;
border-bottom: 3px solid var(--accent);
padding-bottom: 0.4rem;
margin-top: 0;
}
h2 {
color: var(--accent);
font-size: 1.55rem;
border-bottom: 2px solid var(--violet);
padding-bottom: 0.3rem;
}
h3 {
color: var(--violet);
font-size: 1.2rem;
}
h4, h5, h6 {
color: var(--text);
font-size: 1rem;
}
p {
margin: 0.9rem 0;
}
strong { color: var(--accent); font-weight: 700; }
em { color: var(--violet); font-style: italic; }
/* ── Links ─────────────────────────────────────────────────────────── */
a {
color: var(--violet);
text-decoration: none;
border-bottom: 1px solid transparent;
transition: color 0.15s, border-color 0.15s;
}
a:hover {
color: var(--accent);
border-bottom-color: var(--accent);
}
/* ── Code ──────────────────────────────────────────────────────────── */
code {
font-family: inherit;
background: var(--bg2);
color: var(--violet);
border: 1px solid var(--violet);
border-radius: var(--radius-sm);
padding: 0.1em 0.42em;
font-size: 0.9em;
}
pre {
background: var(--bg2);
border: 2px solid var(--violet);
border-radius: var(--radius);
padding: 1.2rem 1.4rem;
overflow-x: auto;
margin: 1.2rem 0;
position: relative;
}
pre code {
background: transparent;
border: none;
padding: 0;
color: var(--text);
font-size: 0.875em;
line-height: 1.6;
}
/* Syntax-like token colouring (no JS required — structural only) */
pre code .kw { color: var(--accent); }
pre code .str { color: var(--violet); }
pre code .cm { color: #666; font-style: italic; }
/* ── Horizontal Rule ───────────────────────────────────────────────── */
hr {
border: none;
border-top: 2px solid var(--violet);
margin: 2rem 0;
opacity: 0.45;
}
/* ── Blockquote ────────────────────────────────────────────────────── */
blockquote {
border-left: 4px solid var(--accent);
background: var(--bg2);
margin: 1.2rem 0;
padding: 0.8rem 1.2rem;
border-radius: 0 var(--radius) var(--radius) 0;
color: var(--text);
opacity: 0.9;
}
blockquote p { margin: 0; }
/* ── Tables ────────────────────────────────────────────────────────── */
table {
width: 100%;
border-collapse: collapse;
border: 2px solid var(--border);
border-radius: var(--radius);
overflow: hidden;
margin: 1.2rem 0;
font-size: 0.9em;
}
th {
background: var(--violet);
color: var(--bg);
text-align: left;
padding: 0.55rem 0.9rem;
font-weight: 700;
letter-spacing: 0.03em;
}
td {
padding: 0.5rem 0.9rem;
border-top: 1px solid var(--bg3);
vertical-align: top;
}
tr:nth-child(even) td { background: var(--bg2); }
tr:hover td { background: var(--bg3); }
/* ── Lists ─────────────────────────────────────────────────────────── */
ul, ol {
padding-left: 1.6rem;
margin: 0.7rem 0;
}
li { margin: 0.25rem 0; }
ul li::marker { color: var(--accent); }
ol li::marker { color: var(--violet); font-weight: 700; }
/* ── Nav sidebar (index page) ──────────────────────────────────────── */
nav ul {
list-style: none;
padding: 0;
}
nav li { margin: 0.3rem 0; }
/* ── Page Header Bar ───────────────────────────────────────────────── */
.page-header {
border-bottom: 3px solid var(--accent);
padding-bottom: 0.6rem;
margin-bottom: 2rem;
display: flex;
align-items: baseline;
gap: 1rem;
}
.page-header .site-title {
color: var(--accent);
font-size: 0.85rem;
opacity: 0.75;
white-space: nowrap;
}
/* ── Back link ─────────────────────────────────────────────────────── */
.back-link {
display: inline-block;
color: var(--violet);
font-size: 0.85rem;
margin-bottom: 1.5rem;
padding: 0.25rem 0.75rem;
border: 1px solid var(--violet);
border-radius: 30px;
transition: background 0.15s, color 0.15s;
}
.back-link:hover {
background: var(--violet);
color: var(--bg);
border-bottom-color: transparent;
}
/* ── Footer ────────────────────────────────────────────────────────── */
footer {
margin-top: 4rem;
padding-top: 1rem;
border-top: 1px solid var(--bg3);
color: var(--text);
opacity: 0.4;
font-size: 0.8rem;
text-align: center;
}
/* ── Responsive ────────────────────────────────────────────────────── */
@media (max-width: 680px) {
body { padding: 1.2rem 1rem 3rem; font-size: 14px; }
h1 { font-size: 1.7rem; }
h2 { font-size: 1.3rem; }
table { display: block; overflow-x: auto; }
}
/* ── Selection ─────────────────────────────────────────────────────── */
::selection {
background: var(--accent);
color: var(--bg);
}
/* ── Scrollbar ─────────────────────────────────────────────────────── */
::-webkit-scrollbar { width: 8px; height: 8px; }
::-webkit-scrollbar-track { background: var(--bg2); }
::-webkit-scrollbar-thumb { background: var(--violet); border-radius: 4px; }
::-webkit-scrollbar-thumb:hover { background: var(--accent); }
</style>
</head>
<body>
<header class="page-header">
<span class="site-title">M-Archy Dotfiles</span>
</header>
<a class="back-link" href="index.html">← Index</a>
<main>
<h1 id="installation">Installation<a class="toc-anchor" href="#installation" title="Permanent link">&para;</a></h1>
<p>Three paths are available depending on how much you want to automate:</p>
<table>
<thead>
<tr>
<th>Path</th>
<th>When to use</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="#interactive-tui">Interactive TUI</a></td>
<td>Fresh Arch system, guided dialogs</td>
</tr>
<tr>
<td><a href="#answerfile-automated">Answerfile (automated)</a></td>
<td>Unattended or repeatable installs</td>
</tr>
<tr>
<td><a href="#custom-live-iso">Custom ISO</a></td>
<td>Deploy from USB to multiple machines</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="prerequisites">Prerequisites<a class="toc-anchor" href="#prerequisites" title="Permanent link">&para;</a></h2>
<ul>
<li>Arch Linux (base install completed, user created)</li>
<li>Internet connection</li>
<li><code>git</code> available (<code>sudo pacman -S git</code>)</li>
</ul>
<hr />
<h2 id="interactive-tui">Interactive TUI<a class="toc-anchor" href="#interactive-tui" title="Permanent link">&para;</a></h2>
<p>Clone the repo and run the installer:</p>
<pre><code class="language-bash">git clone https://git.abdelbaki.eu/The_miro/Dotfiles.git ~/Dotfiles
bash ~/Dotfiles/setup/tui-install.sh
</code></pre>
<p>The TUI walks you through:</p>
<ol>
<li><strong>Hostname</strong> — optional; sets <code>/etc/hostname</code> immediately</li>
<li><strong>Components</strong> — pick any combination:</li>
<li><code>pkg</code> — package managers (yay, nvm, Rust)</li>
<li><code>core</code> — 100+ base system packages</li>
<li><code>svc</code> — core services (NetworkManager, cronie, fail2ban, greetd)</li>
<li><code>shell</code> — zsh, Neovim, Yazi, Micro, Starship</li>
<li><strong>Desktop Environment</strong> — Hyprland, Sway, KDE Plasma, GNOME, COSMIC, XFCE, LXQt, or none</li>
<li><strong>Applications</strong> — checklist of ~50 optional apps (see <a href="modules.md">Modules</a>)</li>
<li><strong>Colorway</strong> — optional; enter hex values to customise the CyberQueer palette</li>
</ol>
<p>All activity is logged to <code>~/dotfiles-install.log</code>.</p>
<h3 id="adding-modules-later">Adding Modules Later<a class="toc-anchor" href="#adding-modules-later" title="Permanent link">&para;</a></h3>
<p>To install additional optional apps on an already-configured system:</p>
<pre><code class="language-bash">bash ~/Dotfiles/setup/install-modules.sh
</code></pre>
<p>This presents the same app checklist without re-running core setup.</p>
<hr />
<h2 id="answerfile-automated">Answerfile (Automated)<a class="toc-anchor" href="#answerfile-automated" title="Permanent link">&para;</a></h2>
<p>An <strong>answerfile</strong> lets the entire install — base OS <em>and</em> dotfiles — run without any user input.</p>
<h3 id="generating-an-answerfile">Generating an Answerfile<a class="toc-anchor" href="#generating-an-answerfile" title="Permanent link">&para;</a></h3>
<pre><code class="language-bash">bash ~/Dotfiles/setup/generate-answerfile.sh [OUTPUT_PATH]
# Default output: ~/answerfile.json
</code></pre>
<p>This dry-runs every installer dialog and saves your choices. <strong>No software is installed.</strong> Passwords are intentionally excluded — you will be prompted at install time.</p>
<h3 id="answerfile-schema">Answerfile Schema<a class="toc-anchor" href="#answerfile-schema" title="Permanent link">&para;</a></h3>
<pre><code class="language-json">{
&quot;_generated&quot;: &quot;2026-05-18T12:00:00+00:00&quot;,
&quot;drive&quot;: &quot;/dev/sda&quot;,
&quot;kernel&quot;: &quot;linux&quot;,
&quot;hostname&quot;: &quot;myhost&quot;,
&quot;username&quot;: &quot;amir&quot;,
&quot;encrypt&quot;: true,
&quot;fido2_root&quot;: false,
&quot;fido2_user&quot;: false,
&quot;run_tui&quot;: true,
&quot;components&quot;: [&quot;pkg&quot;, &quot;core&quot;, &quot;svc&quot;, &quot;shell&quot;],
&quot;desktop_environment&quot;: &quot;hyprland&quot;,
&quot;apps&quot;: [&quot;firefox-browser&quot;, &quot;vscodium&quot;, &quot;docker&quot;],
&quot;colors&quot;: {
&quot;COLOR_TEXT&quot;: &quot;D6ABAB&quot;,
&quot;COLOR_BG&quot;: &quot;1A1A1A&quot;,
&quot;COLOR_HIGHLIGHT&quot;: &quot;E40046&quot;,
&quot;COLOR_DARK&quot;: &quot;5018DD&quot;,
&quot;COLOR_RED&quot;: &quot;F50505&quot;
}
}
</code></pre>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>drive</code></td>
<td>string</td>
<td>Install target (<code>/dev/sda</code>, <code>/dev/nvme0n1</code>, …)</td>
</tr>
<tr>
<td><code>kernel</code></td>
<td>string</td>
<td><code>linux</code>, <code>linux-lts</code>, or <code>linux-zen</code></td>
</tr>
<tr>
<td><code>hostname</code></td>
<td>string</td>
<td>Base hostname — a MAC-address suffix is appended automatically</td>
</tr>
<tr>
<td><code>username</code></td>
<td>string</td>
<td>Primary user account name</td>
</tr>
<tr>
<td><code>encrypt</code></td>
<td>bool</td>
<td>Enable LUKS2 root encryption</td>
</tr>
<tr>
<td><code>fido2_root</code></td>
<td>bool</td>
<td>Enroll FIDO2 key for LUKS unlock</td>
</tr>
<tr>
<td><code>fido2_user</code></td>
<td>bool</td>
<td>Enroll FIDO2 key for PAM login</td>
</tr>
<tr>
<td><code>run_tui</code></td>
<td>bool</td>
<td>Run dotfiles setup automatically after base install</td>
</tr>
<tr>
<td><code>components</code></td>
<td>array</td>
<td>Dotfiles components to install</td>
</tr>
<tr>
<td><code>desktop_environment</code></td>
<td>string</td>
<td>DE name or <code>"none"</code></td>
</tr>
<tr>
<td><code>apps</code></td>
<td>array</td>
<td>Optional app IDs (see <a href="modules.md">Modules</a>)</td>
</tr>
<tr>
<td><code>colors</code></td>
<td>object</td>
<td>Optional colour overrides (omit to keep defaults)</td>
</tr>
</tbody>
</table>
<h3 id="hostname-uniqueness">Hostname Uniqueness<a class="toc-anchor" href="#hostname-uniqueness" title="Permanent link">&para;</a></h3>
<p>When <code>hostname</code> is set in the answerfile, the MAC address of the primary network interface is automatically appended:</p>
<pre><code>myhost → myhost-aabbccddee11
</code></pre>
<p>This prevents hostname conflicts when the same answerfile is used across multiple machines.</p>
<h3 id="running-with-an-answerfile">Running with an Answerfile<a class="toc-anchor" href="#running-with-an-answerfile" title="Permanent link">&para;</a></h3>
<p>Place the file at <code>/answerfile.json</code> (or set the <code>ANSWERFILE</code> environment variable):</p>
<pre><code class="language-bash"># Use default location
sudo cp ~/answerfile.json /answerfile.json
bash ~/Dotfiles/setup/tui-install.sh
# Or override the path
ANSWERFILE=~/my-setup.json bash ~/Dotfiles/setup/tui-install.sh
</code></pre>
<hr />
<h2 id="base-os-installers">Base OS Installers<a class="toc-anchor" href="#base-os-installers" title="Permanent link">&para;</a></h2>
<p>Two scripts install Arch Linux itself (before the dotfiles step):</p>
<h3 id="guided-installer-archbaseos-guided-installsh">Guided Installer (<code>archbaseos-guided-install.sh</code>)<a class="toc-anchor" href="#guided-installer-archbaseos-guided-installsh" title="Permanent link">&para;</a></h3>
<p>Interactive, dialog-based. Prompts for each setting with sensible defaults. Good for hands-on installs where you want to review each option.</p>
<pre><code class="language-bash">bash ~/installer/archbaseos-guided-install.sh
</code></pre>
<h3 id="auto-installer-arch-autoinstallsh">Auto Installer (<code>arch-autoinstall.sh</code>)<a class="toc-anchor" href="#auto-installer-arch-autoinstallsh" title="Permanent link">&para;</a></h3>
<p>Reads all settings from <code>/answerfile.json</code> if present; falls back to prompts for anything missing.</p>
<pre><code class="language-bash">bash ~/installer/arch-autoinstall.sh
</code></pre>
<p>Both installers perform the same steps:</p>
<ol>
<li>Partition disk (EFI 15 GiB · Root · Swap = RAM size)</li>
<li>Optionally encrypt root with LUKS2</li>
<li>Format root as Btrfs with <code>@</code> and <code>@home</code> subvolumes</li>
<li><code>pacstrap</code> base system</li>
<li>Configure locale, timezone, hostname, user, sudo</li>
<li>Set up mkinitcpio hooks and GRUB</li>
<li>Optionally run <code>tui-install.sh</code> inside the chroot</li>
</ol>
<h3 id="disk-encryption">Disk Encryption<a class="toc-anchor" href="#disk-encryption" title="Permanent link">&para;</a></h3>
<p>When encryption is enabled:</p>
<ul>
<li><strong>Primary key</strong>: entered interactively at install time</li>
<li><strong>Backup key</strong>: generated automatically from <code>/dev/urandom</code>, enrolled into a second LUKS slot, and written to <code>/_LUKS_BACKUP_KEY</code> inside the new system (mode <code>0400</code>, root-readable only, inside the encrypted container)</li>
<li><strong>FIDO2</strong> (optional): enroll a hardware key for passwordless unlock</li>
</ul>
<p>The backup key can be collected by Ansible — see <a href="freeipa-ansible.md">FreeIPA &amp; Ansible</a>.</p>
<h3 id="mkinitcpio-hook-sets">mkinitcpio Hook Sets<a class="toc-anchor" href="#mkinitcpio-hook-sets" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Scenario</th>
<th>Hooks</th>
</tr>
</thead>
<tbody>
<tr>
<td>No encryption</td>
<td><code>base udev autodetect microcode modconf kms consolefont block btrfs filesystems keyboard fsck</code></td>
</tr>
<tr>
<td>LUKS + password</td>
<td><code>base udev autodetect microcode modconf kms consolefont block encrypt lvm2 btrfs filesystems keyboard keymap fsck</code></td>
</tr>
<tr>
<td>LUKS + FIDO2</td>
<td><code>base udev systemd autodetect microcode modconf kms consolefont block sd-encrypt lvm2 btrfs filesystems keyboard keymap fsck</code></td>
</tr>
</tbody>
</table>
<hr />
<h2 id="custom-live-iso">Custom Live ISO<a class="toc-anchor" href="#custom-live-iso" title="Permanent link">&para;</a></h2>
<p>See <a href="archiso.md">Archiso</a> for building a bootable USB that embeds the installer and, optionally, a pre-baked answerfile for zero-touch deployment.</p>
</main>
<footer>
Generated by md-to-html.sh &nbsp;·&nbsp; CyberQueer theme &nbsp;·&nbsp; 2026-05-18
</footer>
</body>
</html>