diff options
Diffstat (limited to 'website/docs/install.md')
| -rw-r--r-- | website/docs/install.md | 254 |
1 files changed, 146 insertions, 108 deletions
diff --git a/website/docs/install.md b/website/docs/install.md index 53cf9bb0..155d9ecc 100644 --- a/website/docs/install.md +++ b/website/docs/install.md @@ -7,45 +7,51 @@ Get Alice rootfs tarball ------------------------ Download the Alice rootfs tarball from the [release](https://codeberg.org/emmett1/alicelinux/releases) page, along with its `sha256sum` file. - - $ curl -O <url> - $ curl -O <url>.sha256sum +``` +$ curl -O <url> +$ curl -O <url>.sha256sum +``` Verify the checksum of the Alice rootfs tarball: - - $ sha256sum -c alicelinux-rootfs-20240525.tar.xz.sha256sum +``` +$ sha256sum -c alicelinux-rootfs-20240525.tar.xz.sha256sum +``` Make sure it prints: - - alicelinux-rootfs-20240525.tar.xz: OK - +``` +alicelinux-rootfs-20240525.tar.xz: OK +``` Prepare the partition and filesystem ------------------------------------ Prepare the partition and filesystem of your choice. In this guide, I will use `ext4` as an example. - - # cfdisk /dev/sdX - # mkfs.ext4 /dev/sdXY +``` +# cfdisk /dev/sdX +# mkfs.ext4 /dev/sdXY +``` Mount your created partition somewhere. In this guide, I will use `/mnt/alice` as the mount point. - - # mkdir /mnt/alice - # mount /dev/sdXY /mnt/alice +``` +# mkdir /mnt/alice +# mount /dev/sdXY /mnt/alice +``` Extract the Alice rootfs tarball -------------------------------- Extract the Alice rootfs into the mounted partition. - - $ tar xvf alicelinux-rootfs-*.tar.xz -C /mnt/alice +``` +$ tar xvf alicelinux-rootfs-*.tar.xz -C /mnt/alice +``` Enter chroot ------------ First, chroot into Alice. (Replace `/mnt/alice` with your chosen mount point) - - # /mnt/alice/usr/bin/apkg-chroot /mnt/alice +``` +# /mnt/alice/usr/bin/apkg-chroot /mnt/alice +``` Any further commands after this will be executed inside the Alice environment. @@ -55,73 +61,83 @@ Configure apkg.conf 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. 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/apkg.conf +``` And use whats in `CFLAGS` for `CXXFLAGS`. - - # echo 'export CXXFLAGS="$CFLAGS"' >> /etc/apkg.conf +``` +# echo 'export CXXFLAGS="$CFLAGS"' >> /etc/apkg.conf +``` Next set `MAKEFLAGS`. I will use `6` for my `8 threads` machine. - - # echo 'export MAKEFLAGS="-j6"' >> /etc/apkg.conf +``` +# echo 'export MAKEFLAGS="-j6"' >> /etc/apkg.conf +``` 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/apkg.conf +``` 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`. Alice provides two (2) `package repos` (at the time of this writing): `core` and `extra`. `core` contains all base packages, and `extra` includes other packages beyond the base. 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 'APKG_REPO="/var/lib/repos/core /var/lib/repos/extra"' >> /etc/apkg.conf - ->NOTE: All repo paths must be declared in the APKG_REPO variable, separated by a single space. +> NOTE: All repo paths must be declared in the APKG_REPO variable, separated by a single space. 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. First, create the directories: - - # mkdir -p /var/cache/pkg - # mkdir -p /var/cache/src - # mkdir -p /var/cache/work - +``` +# mkdir -p /var/cache/pkg +# mkdir -p /var/cache/src +# mkdir -p /var/cache/work +``` Then add these paths to `/etc/apkg.conf`. - - # 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 '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 +``` Configure reposync.conf ----------------------- `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>`. - - # 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 '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 +``` Now run `reposync` to sync latest package templates. - - # reposync +``` +# reposync +``` After setting up our `package repos`, make sure `apkg` can find the packages. We can use `apkg -s <pattern>` to search for packages. - - # apkg -s sway - swayidle - swaybg - swaylock - sway +``` +# apkg -s sway +swayidle +swaybg +swaylock +sway +``` Lets combine with `-p` flags to show path or package templates. - - # apkg -p $(apkg -s sway) - /var/lib/repos/extra/sway - /var/lib/repos/extra/swaylock - /var/lib/repos/extra/swaybg - /var/lib/repos/extra/swayidle +``` +# apkg -p $(apkg -s sway) +/var/lib/repos/extra/sway +/var/lib/repos/extra/swaylock +/var/lib/repos/extra/swaybg +/var/lib/repos/extra/swayidle +``` If the output appears, then we are good to go. @@ -131,20 +147,23 @@ Full system upgrade/rebuild On the first install, we should upgrade the system first. Before we do, install development packages first. - - # apkg -I meson cmake pkgconf libtool automake perl +``` +# apkg -I meson cmake pkgconf libtool automake perl +``` > NOTE: use upppercase 'i' for solve dependencies, lowecase 'i' without solve dependencies. Now lets upgrade our system. - - # apkg -U +``` +# apkg -U +``` > NOTE: Use uppercase `U` for a system upgrade, and lowercase `u` to upgrade a specific package of your choice. If you changed `CFLAGS` and `CXXFLAGS` to something other than the default, it's a good time to perform a full rebuild first. In this case, you can skip upgrading the system because performing a full rebuild will already use the latest version in `package repos`. - - # apkg -u $(apkg -a) +``` +# apkg -u $(apkg -a) +``` > NOTE: Add the `-f` flag to force rebuild of existing prebuilt package. > NOTE: `apkg -a` prints all installed packages on the system. @@ -153,56 +172,65 @@ Install kernel -------------- You can configure your own kernel from [kernel.org](https://kernel.org/) or use the one provided by Alice. + > NOTE: The provided kernel will take a lot of time to compile because many options are enabled. If you want to use Alice's kernel, just run: - - # apkg -I linux +``` +# apkg -I linux +``` Install firmware ---------------- If your hardware requires firmware, install it using: - - # apkg -I linux-firmware +``` +# apkg -I linux-firmware +``` Install bootloader ------------------ In this guide, I'm going to use `grub` as the bootloader. Install `grub`: - - # apkg -I grub +``` +# apkg -I grub +``` Then generate grub config: - - # grub-install /dev/sdX - # grub-mkconfig -o /boot/grub/grub.cfg +``` +# grub-install /dev/sdX +# grub-mkconfig -o /boot/grub/grub.cfg +``` Hostname -------- Change `alice` to the hostname of your choice. - - # echo alice > /etc/hostname +``` +# echo alice > /etc/hostname +``` Fstab ----- Change the partition and filesystem of your choice below: - - # echo '/dev/sda1 swap swap defaults 0 1' >> /etc/fstab - # echo '/dev/sda2 / ext4 defaults 0 0' >> /etc/fstab +``` +# echo '/dev/sda1 swap swap defaults 0 1' >> /etc/fstab +# echo '/dev/sda2 / ext4 defaults 0 0' >> /etc/fstab +``` Enable runit services --------------------- Alice uses busybox's `runit` as its main service manager. Enable the required services: - - # ln -s /etc/sv/tty1 /var/service - # ln -s /etc/sv/tty2 /var/service - # ln -s /etc/sv/tty3 /var/service +``` +# ln -s /etc/sv/tty1 /var/service +# ln -s /etc/sv/tty2 /var/service +# ln -s /etc/sv/tty3 /var/service +``` I'm enabling 3 `tty` services. `tty` is required; without it, you won't be able to log in (or run any commands). + > The runit service directory is `/etc/sv`. > Create a symlink from `/etc/sv/<service>` to `/var/service` to enable it; remove the symlink to disable it. @@ -210,67 +238,77 @@ Setup user and password ----------------------- Add your user: - - # adduser <user> +``` +# adduser <user> +``` Add your user to the `wheel` group: - - # adduser <user> wheel +``` +# adduser <user> wheel +``` You might need to add your user to the `input` and `video` groups to start the Wayland compositor later, and the `audio` group to have working audio: - - # adduser <user> input - # adduser <user> video - # adduser <user> audio - +``` +# adduser <user> input +# adduser <user> video +# adduser <user> audio +``` Root password ------------- Set the password for the `root` user: - - # passwd +``` +# passwd +``` Networking ---------- You might want to set up networking before rebooting. Use `wpa_supplicant` and `dhcpcd`. - - # apkg -I wpa_supplicant dhcpcd +``` +# apkg -I wpa_supplicant dhcpcd +``` Configure your SSID: - - # wpa_passphrase <YOUR SSID> <ITS PASSWORD> >> /etc/wpa_supplicant.conf +``` +# wpa_passphrase <YOUR SSID> <ITS PASSWORD> >> /etc/wpa_supplicant.conf +``` Enable the service: - - # ln -s /etc/sv/wpa_supplicant /var/service - # ln -s /etc/sv/dhcpcd /var/service +``` +# ln -s /etc/sv/wpa_supplicant /var/service +# ln -s /etc/sv/dhcpcd /var/service +``` Timezone -------- Install `tzdata`: - - # apkg -I tzdata +``` +# apkg -I tzdata +``` Then create a symlink for your timezone to `/etc/localtime`: - - # ln -s /usr/share/zoneinfo/Asia/Kuala_Lumpur /etc/localtime +``` +# ln -s /usr/share/zoneinfo/Asia/Kuala_Lumpur /etc/localtime +``` Alternatively, you can copy it and then uninstall `tzdata` to keep your installed packages minimal: - - # cp /usr/share/zoneinfo/Asia/Kuala_Lumpur /etc/localtime - # apkg -r tzdata +``` +# cp /usr/share/zoneinfo/Asia/Kuala_Lumpur /etc/localtime +# apkg -r tzdata +``` Reboot and enjoy! ----------------- Exit the chroot environment and unmount the Alice partition, then reboot: - - # exit - # umount /mnt/alice - # reboot +``` +# exit +# umount /mnt/alice +# reboot +``` Some important notes ==================== |