particle-os-modules/modules/akmods
Nick Saika 17bacbe3da
fix: Fix flag ordering in set calls in scripts (#99)
The README for scripts has an incorrect use of the `set`. Where it says
to use:

	set -oue pipefail

it should be:

	set -euo pipefail

since `pipefail` is an option consumed by `set -o`.

More information: https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html
2024-01-16 06:12:08 +00:00
..
akmods.sh fix: Fix flag ordering in set calls in scripts (#99) 2024-01-16 06:12:08 +00:00
README.md feat: Add akmods module (#89) 2024-01-14 16:45:20 +00:00

Warning

Only Universal Blue based images are officially supported.

Warning

Universal Blue builds with Fedora 38 & below are not supported.

Warning

Custom kernels are not supported.

akmods Module for Startingpoint

The akmods module is a tool used for managing and installing kernel modules. It simplifies the installation of kernel modules, improving the capabilities of your system.

List of all available kernel modules & versions/tags are here: https://github.com/ublue-os/akmods

Ublue-os-akmods-addons & ublue-os-nvidia-addons are already included when necessary, so they are not needed to install.

To use the akmods module, specify the kernel modules you wish to install in the install: section of your recipe/configuration file.

Example configuration

type: akmods
install:
    - openrazer
    - openrgb
    - v4l2loopback
    - winesync

By default, the akmods module installs the main akmods for latest version of Fedora. main akmods are also compatible with other images except surface(-nvidia) & asus(-nvidia).

If you want to install akmods for surface(-nvidia) or asus(-nvidia) images, or for older version of Fedora, change this part in the Containerfile: See available tags here: https://github.com/ublue-os/akmods/#how-its-organized

# Change this if you want different version/tag of akmods.
COPY --from=ghcr.io/ublue-os/akmods:main-39 /rpms /tmp/rpms