-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Add akmods module #89
Merged
Merged
Changes from 19 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
fa3daec
feat: Add kmods installer module
fiftydinar b333c75
Rename kmods installer to akmods
fiftydinar db60089
Merge remote-tracking branch 'upstream/main' into kmods-installer
fiftydinar 9927378
Update README
fiftydinar d76cca4
Fix README typo
fiftydinar 0b89032
Remove non-needed space for yml in README
fiftydinar adc02bd
Add support for Surface & Asus images
fiftydinar d3993a3
Clarify tagged base image warning better
fiftydinar 40e90fa
Clarify tagged base image warning better pt.2
fiftydinar 9ff238f
There is no need to fetch main-nvidia build for now
fiftydinar 43a6640
Use simpler =~ for conditioning instead of grep & sed
fiftydinar 4662a9a
Install kernel-devel-matched for all builds
fiftydinar cd65d0b
Assure that Surface installs their version of kernel-devel-matched
fiftydinar 8fba4da
Mention that framework images can be used as a base
fiftydinar 23a8426
Delete duplicate warning message
fiftydinar 01b9720
Remove non-needed explanation on why only Universal Blue builds are s…
fiftydinar 2e1add2
Clarify 1st warning better
fiftydinar a0ac3d0
Clarify `main` akmods compatibility better
fiftydinar 8f76f1d
docs(akmods): grammar fixes
xynydev 2c5ce42
docs: add link to akmod tag matrix
xynydev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
> [!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 | ||
```yaml | ||
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: | ||
|
||
``` | ||
# Change this if you want different version/tag of akmods. | ||
COPY --from=ghcr.io/ublue-os/akmods:main-39 /rpms /tmp/rpms | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
#!/usr/bin/env bash | ||
set -oue pipefail | ||
|
||
BASED_IMAGE=$(echo "${BASE_IMAGE}") | ||
|
||
get_yaml_array INSTALL '.install[]' "$1" | ||
|
||
INSTALL_PATH=("${INSTALL[@]/#/\/tmp/rpms/kmods/*}") | ||
INSTALL_PATH=("${INSTALL_PATH[@]/%/*.rpm}") | ||
INSTALL_STR=$(echo "${INSTALL_PATH[*]}" | tr -d '\n') | ||
|
||
if [[ ${#INSTALL[@]} -gt 0 ]]; then | ||
echo "Installing akmods" | ||
echo "Installing: $(echo "${INSTALL[*]}" | tr -d '\n')" | ||
if [[ "$BASED_IMAGE" =~ "surface" ]]; then | ||
rpm-ostree install kernel-surface-devel-matched $INSTALL_STR | ||
else | ||
rpm-ostree install kernel-devel-matched $INSTALL_STR | ||
fi | ||
fi |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the point of this? The
BASE_IMAGE
andBASED_IMAGE
variable are identical, no?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, there is no need for this.
I can correct this in another PR.