5e455a1477
* feat: add initial module.yml for rpm-ostree * chore: add shortdesc to module.yml * feat: add missing module.ymls * feat: add website rebuild action for module reference updates * chore: remove old readme in modules dir * refactor: switch to a hybrid module.yml + README arrangement * chore: switch docs to use starlight aside syntax
26 lines
No EOL
1.3 KiB
Markdown
26 lines
No EOL
1.3 KiB
Markdown
# `akmods`
|
|
|
|
:::caution
|
|
Only Universal Blue based images are officially supported. Universal Blue builds with Fedora 38 & below are not supported. Custom kernels are not supported.
|
|
:::
|
|
|
|
The [`akmods`](https://github.com/ublue-os/akmods) module is a tool used for managing and installing kernel modules built by Universal Blue. 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.
|
|
|
|
By default, the `akmods` module installs the `main` akmods for the `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:
|
|
|
|
```
|
|
# Change this if you want different version/tag of akmods.
|
|
COPY --from=ghcr.io/ublue-os/akmods:main-39 /rpms /tmp/rpms
|
|
```
|
|
|
|
See available tags here: https://github.com/ublue-os/akmods/#how-its-organized |