aboutsummaryrefslogtreecommitdiff
path: root/docs/install.md
diff options
context:
space:
mode:
authoremmett1 <me@emmett1.my>2026-06-03 00:08:49 +0800
committeremmett1 <me@emmett1.my>2026-06-03 00:08:49 +0800
commitd81f312365113d2c06e38b7cc8a4654fae72d87f (patch)
tree4e3294ecc81814a181538526e6c852ac01b620ff /docs/install.md
parent7d266fc1171fb55f8758d5170d40e5032058163e (diff)
downloadalicelinux-d81f312365113d2c06e38b7cc8a4654fae72d87f.tar.gz
alicelinux-d81f312365113d2c06e38b7cc8a4654fae72d87f.zip
docs updated
Diffstat (limited to 'docs/install.md')
-rw-r--r--docs/install.md88
1 files changed, 30 insertions, 58 deletions
diff --git a/docs/install.md b/docs/install.md
index b37747f6..d032ad51 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -6,7 +6,7 @@ Here is a guide to installing Alice Linux on your computer using the chroot meth
Get Alice rootfs tarball
------------------------
-Download the Alice rootfs tarball from the [release](https://codeberg.org/emmett1/alicelinux/releases) page, along with its `sha256sum` file.
+Download the Alice rootfs tarball from the [download](https://alicelinux.org/download.html) page, along with its `sha256sum` file.
```
$ curl -O <url>
$ curl -O <url>.sha256sum
@@ -51,29 +51,29 @@ First, chroot into Alice. (Replace `/mnt/alice` with your chosen mount point)
Any further commands after this will be executed inside the Alice environment.
-Configure apkg.conf
--------------------
+Configure apkg
+---------------
-Once we have the repositories cloned, we need to configure `apkg`. `apkg` is Alice's package build system (or package manager). By default, Alice does not provide an `apkg` config file (yes, `apkg` can work without a config file), but we need to create one. The `apkg` config file should be located at `/etc/apkg.conf` by default. Let's create one.
+Once we have the repositories cloned, we need to configure `apkg`. `apkg` is Alice's package build system (or package manager). `apkg` configuration is environment-based -- settings are exported as environment variables. Place them in `/etc/profile.d/apkg.sh` for system-wide configuration, or in `~/.profile` for per-user configuration.
First, we set `CFLAGS` and `CXXFLAGS`. Alice base packages are built using `-O3 -march=x86-64 -pipe`. You can use these settings or change them to your preference.
```
-# echo 'export CFLAGS="-O3 -march=x86-64 -pipe"' >> /etc/apkg.conf
+# echo 'export CFLAGS="-O3 -march=x86-64 -pipe"' >> /etc/profile.d/apkg.sh
```
And use whats in `CFLAGS` for `CXXFLAGS`.
```
-# echo 'export CXXFLAGS="$CFLAGS"' >> /etc/apkg.conf
+# echo 'export CXXFLAGS="$CFLAGS"' >> /etc/profile.d/apkg.sh
```
Next set `MAKEFLAGS`. I will use `6` for my `8 threads` machine.
```
-# echo 'export MAKEFLAGS="-j6"' >> /etc/apkg.conf
+# echo 'export MAKEFLAGS="-j6"' >> /etc/profile.d/apkg.sh
```
I'm also going to set `NINJAJOBS` here. Without it, `ninja` will use all threads of your machine when compiling.
```
-# echo 'export NINJAJOBS="6"' >> /etc/apkg.conf
+# echo 'export NINJAJOBS="6"' >> /etc/profile.d/apkg.sh
```
Next, we need to set the package's build scripts path (I'll call it `package repos`) so `apkg` can find them. The `APKG_REPO` variable can accept multiple values for multiple `package repos`.
@@ -82,14 +82,14 @@ Alice provides two (2) `package repos` (at the time of this writing): `core` and
I'm gonna use directory `/var/lib/repos/core` and `/var/lib/repos/extra` for `core` and `extra` repos respectively.
```
-# echo 'APKG_REPO="/var/lib/repos/core /var/lib/repos/extra"' >> /etc/apkg.conf
+# echo 'export APKG_REPO="/var/lib/repos/core /var/lib/repos/extra"' >> /etc/profile.d/apkg.sh
```
You can also create a directory the community repo.
> NOTE: The community repo is not held to the same standards as the official repos.
> Additionally all repo paths must be declared in the APKG_REPO variable, separated by a single space.
```
-# echo 'APKG_REPO="/var/lib/repos/core /var/lib/repos/extra /var/lib/repos/community"' >> /etc/apkg.conf
+# echo 'export APKG_REPO="/var/lib/repos/core /var/lib/repos/extra /var/lib/repos/community"' >> /etc/profile.d/apkg.sh
```
Next, we will set up directories for `packages`, `sources`, and `work`. By default, these directories are inside the package template, but we will change them to `/var/cache/pkg`, `/var/cache/src`, and `/var/cache/work` respectively. You can change these to any location where you want to store these files.
@@ -101,26 +101,26 @@ First, create the directories.
# mkdir -p /var/cache/work
```
-Then add these paths to `/etc/apkg.conf`.
+Then add these paths to `/etc/profile.d/apkg.sh`.
```
-# echo 'APKG_PACKAGE_DIR=/var/cache/pkg' >> /etc/apkg.conf
-# echo 'APKG_SOURCE_DIR=/var/cache/src' >> /etc/apkg.conf
-# echo 'APKG_WORK_DIR=/var/cache/work' >> /etc/apkg.conf
+# echo 'export APKG_PACKAGE_DIR=/var/cache/pkg' >> /etc/profile.d/apkg.sh
+# echo 'export APKG_SOURCE_DIR=/var/cache/src' >> /etc/profile.d/apkg.sh
+# echo 'export APKG_WORK_DIR=/var/cache/work' >> /etc/profile.d/apkg.sh
```
-Configure reposync.conf
------------------------
+Configure reposync
+--------------------
-`reposync` is a tool to sync package templates from git repositories. Add remote repos for `core` and `extra` into `/etc/reposync.conf`. The format of remote repos in `reposync.conf` is `<gitrepo>|<branch>|<localpath>`.
+`reposync` is a tool to sync package templates from git repositories. Like `apkg`, `reposync` configuration is environment-based. Add remote repos for `core` and `extra` to `/etc/profile.d/reposync.sh` (system-wide) or `~/.profile` (per-user). The format is `<gitrepo>|<branch>|<localpath>`.
```
-# echo 'https://codeberg.org/emmett1/alicelinux|core|/var/lib/repos/core' >> /etc/reposync.conf
-# echo 'https://codeberg.org/emmett1/alicelinux|extra|/var/lib/repos/extra' >> /etc/reposync.conf
+# echo 'export REPOSYNC_CORE="https://codeberg.org/emmett1/alicelinux|core|/var/lib/repos/core"' >> /etc/profile.d/reposync.sh
+# echo 'export REPOSYNC_EXTRA="https://codeberg.org/emmett1/alicelinux|extra|/var/lib/repos/extra"' >> /etc/profile.d/reposync.sh
```
If you also want the community repo, add it as well.
> NOTE: The community repo is not held to the same standards as the official repos.
```
-# echo 'https://codeberg.org/emmett1/alicelinux|community|/var/lib/repos/community' >> /etc/reposync.conf
+# echo 'export REPOSYNC_COMMUNITY="https://codeberg.org/emmett1/alicelinux|community|/var/lib/repos/community"' >> /etc/profile.d/reposync.sh
```
@@ -196,20 +196,6 @@ If your hardware requires firmware, install it using.
# apkg -I linux-firmware
```
-Install bootloader
-------------------
-
-In this guide, I'm going to use `grub` as the bootloader. Install `grub`.
-```
-# apkg -I grub
-```
-
-Then generate grub config.
-```
-# grub-install /dev/sdX
-# grub-mkconfig -o /boot/grub/grub.cfg
-```
-
Hostname
--------
@@ -270,30 +256,6 @@ Set the password for the `root` user.
# passwd
```
-Networking
-----------
-
-You might want to set up networking before rebooting. For wifi connection, install `wpa_supplicant`.
-```
-# apkg -I wpa_supplicant
-```
-
-Configure your SSID.
-```
-# wpa_passphrase <YOUR SSID> <ITS PASSWORD> >> /etc/wpa_supplicant.conf
-```
-
-Enable the service.
-```
-# ln -s /etc/sv/wpa_supplicant /var/service
-```
-
-Then configure & enable `udhcpc` service.
-```
-# vi /etc/sv/udhcpc/conf
-# ln -s /etc/sv/udhcpc /var/service
-```
-
Timezone
--------
@@ -313,6 +275,16 @@ Alternatively, you can copy it and then uninstall `tzdata` to keep your installe
# apkg -r tzdata
```
+Install bootloader
+------------------
+
+See the [bootloader documentation](bootloader.html) for installing and configuring a bootloader.
+
+Networking
+----------
+
+See the [networking documentation](networking.html) for setting up networking.
+
Reboot and enjoy!
-----------------