AKMS.CONF(5)

🌸 NAME 🌸

akms.conf — the configuration file for akms(8). Yep bestie, this page is akms.conf(5) and it’s giving “tiny shell script, big main character energy”. 💅

✨ SYNOPSIS ✨

/etc/akms.conf

💖 DESCRIPTION 💖

Okay so akms.conf is literally the configuration file for akms(8). 🫶

It is a POSIX shell script with a pre-defined set of variables that MAY be defined to adjust akms’ behaviour. It SHOULD NOT define any functions, variables other than those specified in this page, or execute any non-trivial commands. No cap — keep it cute and keep it boring in the best way. ✨

🎀 VARIABLES 🎀

The following variables MAY be defined by the user to configure akms(8). 🧚

🧡 bubblewrap_opts

Additional options that will be passed to bwrap(1) to create a sandbox (a disposable “container”) for building modules. 🫧 If build dependencies need to be installed, and use_overlayfs is not disabled, this sandbox is created on the overlay (using OverlayFS) of the host’s root file system — it’s basically a disposable snapshot. Iconic.

You may need to bind mount more filesystems to the sandbox if you have a more complicated setup, such as /usr and /var on different file systems or subvolumes. Refer to bwrap(1) for available options. 💜

👑 build_user

Specifies the system user to switch to for loading AKMBUILD(5) files and building modules.

The default value is "akms". Slay.

🚫 disable_trigger

This option allows disabling the APK trigger installed by the akms package. This trigger automatically builds each kernel module with an AKMBUILD(5) file installed via apk(8) into the modules_srcdir.

The default value is "no". Lowkey important, ngl.

🗂️ keep_uninstalled

Specifies whether to keep uninstalled modules in the state directory /var/lib/akms.

If set to "no", the built kernel objects and metadata will be deleted from the state directory after a particular module version is uninstalled from /lib/modules. This happens when the module is explicitly uninstalled from /lib/modules using akms uninstall, or another version of the module is installed for the same kernel using akms install. If set to "yes", the built kernel objects and metadata are kept in the state directory, just the state is changed to built. 💾

The default value is "no". This option can be overridden using akms(8) option --keep or --no-keep, respectively.

📝 log_level

Specifies the default logging level. Any messages with level lower than the specified level will be discarded. Allowed values are: "error", "warn", "info", or "debug".

The default value is "info". This option can be overridden using akms(8) options --quiet (sets level "warn") and --verbose (sets level "debug"). 🫶

📦 makedepends

A space-separated list of dependencies (APK packages) needed for building kernel modules. These dependencies will be automatically installed into the root overlay (or the host system if use_overlayfs is set to "no") before executing AKMBUILD’s build function.

The development package with sources for particular kernel is added automatically to the list and SHOULD NOT be specified here.

The default value is "build-base". Periodt.

📍 modules_dest_path

Specifies the location inside /lib/modules/<kernelver>/ where the kernel object files will be installed. It MUST start with / and SHOULD start with /kernel.

The default value is "/kernel/extra/akms". 💅

🔎 modules_srcdir

Specifies the location of the directory where to look for the directories with AKMBUILD(5) and source files of the kernel modules that can be built and installed. It is not required for this directory to contain only directories with the sources for kernel modules — directories without AKMBUILD(5) file are ignored by akms(8).

The default value is "/usr/src".

🌡️ temp_dir

Specifies the base location for a temporary directory where the root overlay will be created. If the directory doesn’t exist, it will be created when needed. There must be enough space for installing the build dependencies (typically hundreds of MiB), unless they are already installed on the system or use_overlayfs is set to "no".

Since the default location is inside /tmp, which is typically a tmpfs (i.e. in RAM), you should change it to e.g. /var/tmp if your system runs on low RAM. 😭

The default value is "/tmp/akms".

🪄 use_overlayfs

Specifies whether to install the module’s build dependencies into a disposable overlay (OverlayFS) created on top of /, or directly on the host system.

WARNING: This is necessary for building modules automatically using APK triggers (note: kernel-hooks use triggers too), unless you have all the build dependencies installed (i.e. no additional packages are needed).

The default value is "yes". ✨

🛠️ MAKEFLAGS

Specifies the flags to be passed to make(1) to build a kernel module.

The default value is "-j$(nproc)". 🔥

🦋 AUTHORS 🦋

Jakub Jirutka. 💖

😭 REPORTING BUGS 😭

Report bugs to the project’s issue tracker at https://github.com/jirutka/akms/issues. 🫶

🌈 SEE ALSO 🌈

akms(8) AKMBUILD(5)

Go read those too bestie — iykyk. 🧚

👑 AUTHOR 👑

Jakub Jirutka. 👑

---

okay bye bestie — this page is AKMS.CONF(5), dated 2025-01-05. 💖🫶