aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.html37
-rw-r--r--docs/install.html31
-rw-r--r--docs/networking.html223
-rw-r--r--docs/packagemanager.html31
-rw-r--r--docs/readme.html36
5 files changed, 338 insertions, 20 deletions
diff --git a/docs/index.html b/docs/index.html
index 7e1094ef..4436e5ad 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -5,18 +5,30 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Alice Linux - docs</title>
<style>
+ :root {
+ color-scheme: dark;
+ }
body {
font-family: monospace;
font-size: 14px;
line-height: 1.25;
- max-width: 60em;
+ max-width: 92ch;
margin-left: auto;
margin-right: auto;
- padding-left: 1em;
- padding-right: 1em;
+ padding: 1em;
background-color: #242424;
color: #fefefe;
}
+ h1 {
+ margin: 0 0 0.35em;
+ font-size: 2rem;
+ line-height: 1.1;
+ }
+ h2, h3, h4 {
+ line-height: 1.2;
+ margin-top: 1.4em;
+ margin-bottom: 0.5em;
+ }
pre {
background-color: #2b2b2b;
border-radius: 3px;
@@ -38,16 +50,21 @@
table {
width: 100%;
border-collapse: collapse;
+ margin: 0.75rem 0;
}
th, td {
padding: 4px;
}
th {
background-color: #221e1f;
+ text-align: left;
}
table, th, td {
border: 1px dashed #e7e8eb;
}
+ table thead th {
+ border-bottom-color: #e7e8eb;
+ }
a {
color: #90cbf9;
text-decoration: none
@@ -56,17 +73,25 @@
color: #869edc;
text-decoration: underline
}
+ blockquote {
+ margin: 1rem 0;
+ padding-left: 1rem;
+ border-left: 2px solid rgba(254, 254, 254, 0.18);
+ color: #d0d0d0;
+ }
</style>
</head>
<body>
<div class="centered-wrapper">
<h1>docs</h1>
- <a href="/">home</a> / <a href="/docs">docs</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
+ <a href="/">home</a> / <a href="/docs">docs</a> / <a href="/ports.html">ports</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
<hr>
-<p>Here lies documentation for <strong>Alice Linux</strong>.</p>
-<p>If you found any typo or error in docs, or even want to contribute, feel free to <a href="https://codeberg.org/emmett1/alicelinux/issues">open issue</a> :D</p>
+<h1>Documentation</h1>
+<p>This section covers the main parts of <strong>Alice Linux</strong>: installation, package
+management, networking, service supervision, etc.</p>
<ul>
<li><a href="./install.html">Install Alice</a></li>
+<li><a href="./networking.html">Networking</a></li>
<li><a href="./packagemanager.html">Package Manager</a></li>
</ul>
<br><hr>
diff --git a/docs/install.html b/docs/install.html
index 2f967850..f64ff0f9 100644
--- a/docs/install.html
+++ b/docs/install.html
@@ -5,18 +5,30 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Alice Linux - docs</title>
<style>
+ :root {
+ color-scheme: dark;
+ }
body {
font-family: monospace;
font-size: 14px;
line-height: 1.25;
- max-width: 60em;
+ max-width: 92ch;
margin-left: auto;
margin-right: auto;
- padding-left: 1em;
- padding-right: 1em;
+ padding: 1em;
background-color: #242424;
color: #fefefe;
}
+ h1 {
+ margin: 0 0 0.35em;
+ font-size: 2rem;
+ line-height: 1.1;
+ }
+ h2, h3, h4 {
+ line-height: 1.2;
+ margin-top: 1.4em;
+ margin-bottom: 0.5em;
+ }
pre {
background-color: #2b2b2b;
border-radius: 3px;
@@ -38,16 +50,21 @@
table {
width: 100%;
border-collapse: collapse;
+ margin: 0.75rem 0;
}
th, td {
padding: 4px;
}
th {
background-color: #221e1f;
+ text-align: left;
}
table, th, td {
border: 1px dashed #e7e8eb;
}
+ table thead th {
+ border-bottom-color: #e7e8eb;
+ }
a {
color: #90cbf9;
text-decoration: none
@@ -56,12 +73,18 @@
color: #869edc;
text-decoration: underline
}
+ blockquote {
+ margin: 1rem 0;
+ padding-left: 1rem;
+ border-left: 2px solid rgba(254, 254, 254, 0.18);
+ color: #d0d0d0;
+ }
</style>
</head>
<body>
<div class="centered-wrapper">
<h1>docs</h1>
- <a href="/">home</a> / <a href="/docs">docs</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
+ <a href="/">home</a> / <a href="/docs">docs</a> / <a href="/ports.html">ports</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
<hr>
<h1>Install Alice</h1>
<p>Here is a guide to installing Alice Linux on your computer using the chroot method. You can do this from your existing Linux distribution or from a live environment, such as Alice Live or another Linux distribution. Make sure your chosen environment has the necessary partitioning tools, filesystem tools, and extraction tools.</p>
diff --git a/docs/networking.html b/docs/networking.html
new file mode 100644
index 00000000..6916045d
--- /dev/null
+++ b/docs/networking.html
@@ -0,0 +1,223 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>Alice Linux - docs</title>
+ <style>
+ :root {
+ color-scheme: dark;
+ }
+ body {
+ font-family: monospace;
+ font-size: 14px;
+ line-height: 1.25;
+ max-width: 92ch;
+ margin-left: auto;
+ margin-right: auto;
+ padding: 1em;
+ background-color: #242424;
+ color: #fefefe;
+ }
+ h1 {
+ margin: 0 0 0.35em;
+ font-size: 2rem;
+ line-height: 1.1;
+ }
+ h2, h3, h4 {
+ line-height: 1.2;
+ margin-top: 1.4em;
+ margin-bottom: 0.5em;
+ }
+ pre {
+ background-color: #2b2b2b;
+ border-radius: 3px;
+ padding: 10px;
+ overflow-x: auto;
+ }
+ code {
+ color: #f7f3d6;
+ }
+ img {
+ display: block;
+ max-width: 100%;
+ }
+ hr {
+ border: 0;
+ border-top: 1px dashed #fefefe;
+ margin: 20px 0;
+ }
+ table {
+ width: 100%;
+ border-collapse: collapse;
+ margin: 0.75rem 0;
+ }
+ th, td {
+ padding: 4px;
+ }
+ th {
+ background-color: #221e1f;
+ text-align: left;
+ }
+ table, th, td {
+ border: 1px dashed #e7e8eb;
+ }
+ table thead th {
+ border-bottom-color: #e7e8eb;
+ }
+ a {
+ color: #90cbf9;
+ text-decoration: none
+ }
+ a:hover {
+ color: #869edc;
+ text-decoration: underline
+ }
+ blockquote {
+ margin: 1rem 0;
+ padding-left: 1rem;
+ border-left: 2px solid rgba(254, 254, 254, 0.18);
+ color: #d0d0d0;
+ }
+ </style>
+</head>
+<body>
+<div class="centered-wrapper">
+ <h1>docs</h1>
+ <a href="/">home</a> / <a href="/docs">docs</a> / <a href="/ports.html">ports</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
+ <hr>
+<h1>Networking</h1>
+<p>This document describes how to configure networking on <strong>Alice Linux</strong> using <code>eiwd</code>/<code>wpa_supplicant</code> + <code>udhcpc</code>/<code>dhcpcd</code>.</p>
+<hr />
+<h2>Overview</h2>
+<p>Alice Linux uses simple, modular networking tools:</p>
+<p><strong>Link (connection)</strong></p>
+<ul>
+<li>LAN: automatic (cable)</li>
+<li>Wi-Fi: <code>eiwd</code> or <code>wpa_supplicant</code></li>
+</ul>
+<p><strong>IP configuration</strong></p>
+<ul>
+<li><code>udhcpc</code> - BusyBox DHCP client</li>
+<li><code>dhcpcd</code> - DHCP client</li>
+</ul>
+<hr />
+<h2>Establish Network Link</h2>
+<h2>Wired (LAN)</h2>
+<p>Bring interface up:</p>
+<pre><code>ip link set eth0 up
+</code></pre>
+<p>A physical cable connection is usually sufficient.</p>
+<blockquote>
+<p>runit service enabled later will automatically bring up the interface.</p>
+</blockquote>
+<h2>Wi-Fi</h2>
+<p>Bring interface up first:</p>
+<pre><code>ip link set wlan0 up
+</code></pre>
+<blockquote>
+<p>runit service enabled later will automatically bring up the interface.</p>
+</blockquote>
+<p>Then choose ONE method:</p>
+<hr />
+<p><strong>Option A: eiwd</strong></p>
+<p>Install <code>eiwd</code> and <code>resolvconf</code></p>
+<pre><code># apkg -I eiwd resolvconf
+</code></pre>
+<p>To prevent iwd from scanning continuously while not connected, add the following lines to <code>/etc/iwd/main.conf</code>:</p>
+<pre><code>[Scan]
+DisablePeriodicScan=true
+</code></pre>
+<p>To prevent iwd from destroying / recreating wireless interfaces at startup, add the following line to <code>[General]</code>;</p>
+<pre><code>UseDefaultInterface=true
+</code></pre>
+<p>Add network configuration.</p>
+<pre><code># printf 'password\n' | iwd_passphrase ssid &gt; /var/lib/iwd/&lt;ssid&gt;.psk
+</code></pre>
+<blockquote>
+<p>The iwd daemon monitors /var/lib/iwd and automatically loads new network configurations.</p>
+</blockquote>
+<p>Enable <code>eiwd</code> service:</p>
+<pre><code># ln -s /etc/eiwd /var/service
+</code></pre>
+<hr />
+<p><strong>Option B: wpa_supplicant</strong></p>
+<p>Install <code>wpa_supplicant</code> package.</p>
+<pre><code># apkg -I wpa_supplicant
+</code></pre>
+<p>Configure <code>wpa_supplicant.conf</code>:</p>
+<pre><code>wpa_passphrase &quot;SSID_NAME&quot; &quot;PASSWORD&quot; &gt; /etc/wpa_supplicant.conf
+</code></pre>
+<p>Enable <code>wpa_supplicant</code> service:</p>
+<pre><code># ln -s /etc/wpa_supplicant /var/service
+</code></pre>
+<hr />
+<h2>Obtain IP Address (DHCP)</h2>
+<p>Once the interface is connected (LAN or Wi-Fi), obtain an IP address.</p>
+<blockquote>
+<p>This step is identical for both LAN and Wi-Fi.</p>
+</blockquote>
+<hr />
+<p><strong>Option A: udhcpc (BusyBox)</strong></p>
+<p>Enable <code>udhcpc</code> service:</p>
+<pre><code># ln -s /etc/sv/udhcpc /var/service
+</code></pre>
+<blockquote>
+<p>Interface and DNS settings can be adjusted in /etc/sv/udhcpc/conf.</p>
+</blockquote>
+<hr />
+<p><strong>Option B: dhcpcd</strong></p>
+<p>Install <code>dhcpcd</code> first:</p>
+<pre><code># apkg -I dhcpcd
+</code></pre>
+<p>Enable <code>dhcpcd</code> service:</p>
+<pre><code># ln -s /etc/sv/dhcpcd /var/service
+</code></pre>
+<hr />
+<h2>Static Network Configuration</h2>
+<p>To use a static configuration instead of DHCP:</p>
+<pre><code># vi /etc/sv/net-static/conf
+</code></pre>
+<p>Set the following variables:</p>
+<ul>
+<li>IFACE</li>
+<li>IP</li>
+<li>NETMASK</li>
+<li>GATEWAY</li>
+</ul>
+<pre><code># ln -s /etc/sv/net-static /var/service
+</code></pre>
+<hr />
+<h2>Troubleshooting</h2>
+<p>Check interfaces:</p>
+<pre><code>ip addr
+</code></pre>
+<p>Test connectivity:</p>
+<pre><code>ping -c 3 8.8.8.8
+</code></pre>
+<p>Test DNS:</p>
+<pre><code>ping -c 3 google.com
+</code></pre>
+<hr />
+<h2>Quick Reference</h2>
+<p>LAN (DHCP)</p>
+<pre><code># ip link set eth0 up
+# ln -s /etc/sv/udhcpc /var/service
+</code></pre>
+<p>Wi-Fi (iwd + DHCP)</p>
+<pre><code># ip link set wlan0 up
+# printf 'password\n' | iwd_passphrase ssid &gt; /var/lib/iwd/&lt;ssid&gt;.psk
+# ln -s /etc/sv/eiwd /var/service
+# ln -s /etc/sv/udhcpc /var/service
+</code></pre>
+<p>Wi-Fi (wpa_supplicant + DHCP)</p>
+<pre><code># ip link set wlan0 up
+# wpa_passphrase &quot;SSID&quot; &quot;PASS&quot; &gt; /etc/wpa_supplicant.conf
+# ln -s /etc/sv/wpa_supplicant /var/service
+# ln -s /etc/sv/udhcpc /var/service
+</code></pre>
+ <br><hr>
+ <p>Copyright (C) Alice Linux, 2024-2026</p>
+</div>
+</body>
+</html>
diff --git a/docs/packagemanager.html b/docs/packagemanager.html
index a8d05663..ca621d1e 100644
--- a/docs/packagemanager.html
+++ b/docs/packagemanager.html
@@ -5,18 +5,30 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Alice Linux - docs</title>
<style>
+ :root {
+ color-scheme: dark;
+ }
body {
font-family: monospace;
font-size: 14px;
line-height: 1.25;
- max-width: 60em;
+ max-width: 92ch;
margin-left: auto;
margin-right: auto;
- padding-left: 1em;
- padding-right: 1em;
+ padding: 1em;
background-color: #242424;
color: #fefefe;
}
+ h1 {
+ margin: 0 0 0.35em;
+ font-size: 2rem;
+ line-height: 1.1;
+ }
+ h2, h3, h4 {
+ line-height: 1.2;
+ margin-top: 1.4em;
+ margin-bottom: 0.5em;
+ }
pre {
background-color: #2b2b2b;
border-radius: 3px;
@@ -38,16 +50,21 @@
table {
width: 100%;
border-collapse: collapse;
+ margin: 0.75rem 0;
}
th, td {
padding: 4px;
}
th {
background-color: #221e1f;
+ text-align: left;
}
table, th, td {
border: 1px dashed #e7e8eb;
}
+ table thead th {
+ border-bottom-color: #e7e8eb;
+ }
a {
color: #90cbf9;
text-decoration: none
@@ -56,12 +73,18 @@
color: #869edc;
text-decoration: underline
}
+ blockquote {
+ margin: 1rem 0;
+ padding-left: 1rem;
+ border-left: 2px solid rgba(254, 254, 254, 0.18);
+ color: #d0d0d0;
+ }
</style>
</head>
<body>
<div class="centered-wrapper">
<h1>docs</h1>
- <a href="/">home</a> / <a href="/docs">docs</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
+ <a href="/">home</a> / <a href="/docs">docs</a> / <a href="/ports.html">ports</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
<hr>
<h1>Package Manager</h1>
<p>In Alice, two package manager are used, <a href="https://codeberg.org/emmett1/spm">spm</a> and <a href="https://codeberg.org/emmett1/autils">autils</a>. And why two package manager? <code>spm</code> was written for generic package manager for linux distribution. And <code>autils</code> is written specifically for <code>Alice</code> and requires <code>spm</code> in order to install, remove and update packages while managing conflicts. The command <code>apkg</code> (part of <code>autils</code>) is used to fetch and build packages from ports and their <code>abuild</code> files.</p>
diff --git a/docs/readme.html b/docs/readme.html
index a5a78132..54fed867 100644
--- a/docs/readme.html
+++ b/docs/readme.html
@@ -5,18 +5,30 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Alice Linux - docs</title>
<style>
+ :root {
+ color-scheme: dark;
+ }
body {
font-family: monospace;
font-size: 14px;
line-height: 1.25;
- max-width: 60em;
+ max-width: 92ch;
margin-left: auto;
margin-right: auto;
- padding-left: 1em;
- padding-right: 1em;
+ padding: 1em;
background-color: #242424;
color: #fefefe;
}
+ h1 {
+ margin: 0 0 0.35em;
+ font-size: 2rem;
+ line-height: 1.1;
+ }
+ h2, h3, h4 {
+ line-height: 1.2;
+ margin-top: 1.4em;
+ margin-bottom: 0.5em;
+ }
pre {
background-color: #2b2b2b;
border-radius: 3px;
@@ -38,16 +50,21 @@
table {
width: 100%;
border-collapse: collapse;
+ margin: 0.75rem 0;
}
th, td {
padding: 4px;
}
th {
background-color: #221e1f;
+ text-align: left;
}
table, th, td {
border: 1px dashed #e7e8eb;
}
+ table thead th {
+ border-bottom-color: #e7e8eb;
+ }
a {
color: #90cbf9;
text-decoration: none
@@ -56,15 +73,22 @@
color: #869edc;
text-decoration: underline
}
+ blockquote {
+ margin: 1rem 0;
+ padding-left: 1rem;
+ border-left: 2px solid rgba(254, 254, 254, 0.18);
+ color: #d0d0d0;
+ }
</style>
</head>
<body>
<div class="centered-wrapper">
<h1>docs</h1>
- <a href="/">home</a> / <a href="/docs">docs</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
+ <a href="/">home</a> / <a href="/docs">docs</a> / <a href="/ports.html">ports</a> / <a href="https://codeberg.org/emmett1/alicelinux">development</a> / <a href="https://sourceforge.net/projects/alice-linux/files/">download</a> / <a href="/community.html">community</a> / <a href="/donate.html">donate</a>
<hr>
-<p>Here lies documentation for <strong>Alice Linux</strong>.</p>
-<p>If you found any typo or error in docs, or even want to contribute, feel free to <a href="https://codeberg.org/emmett1/alicelinux/issues">open issue</a> :D</p>
+<h1>Documentation</h1>
+<p>This section covers the main parts of <strong>Alice Linux</strong>: installation, package
+management, networking, service supervision, etc.</p>
<br><hr>
<p>Copyright (C) Alice Linux, 2024-2026</p>
</div>