Skip to content

Commit 75d0c06

Browse files
committed
Update readme (symlinks do not work for signing key files)
1 parent c0ec0ac commit 75d0c06

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ This is a personal project that's now released.
1212

1313
#Usage
1414
- modulesFile: Mandatory first positional argument. JSON file that describes the modules to sign and the directory they are contained in. See below for the layout.
15-
- privateKeyFile: Mandatory second positional argument. Your private key file for signing the modules.
16-
- publicKeyFile: Mandatory third positional argument. Your public key file for signing the modules.
15+
- privateKeyFile: Mandatory second positional argument. Your private key file for signing the modules (symlinks do not work for this arg).
16+
- publicKeyFile: Mandatory third positional argument. Your public key file for signing the modules (symlinks do not work for this arg).
1717
- -k/--kernels: Manually sign the provided kernels. Make sure to provide the correct format (see uname -r).
1818
- -h: Show help.
1919
- -d/--debug: Display extra information for debugging
@@ -84,6 +84,7 @@ Manual Mode (-k/--kernels)
8484
- I haven't had the time to boot any virtual machines and test other configurations (mine is Fedora, rpm). I also haven't installed any new kernel versions lately to test if the signing process works on a new one. Signing an existing kernel (already signed) works fine for me though.
8585
- I don't want to use external files to track state so the script will sign modules for any kernel newer than the current one even if they have already been signed. This has no ill effects on the modules though. Basically the script assumes that you will boot the new kernel at some point. You won't be able to boot (I get kicked into recovery mode after a timeout) if your current kernel has unsigned Nvidia modules (as long as you still have secure boot enabled) so the script assumes your current kernel modules are signed.
8686
- There is no way for me to register this script to run when the akmod modules are first built or when a kernel is installed without building packages for various package managers.
87+
- I found out the hard way that you can't use symlinks for your public or private key files so I added a note to the help for those argumants. The sign-file binary doesn't seem to accept a valid link to the files so I can't fix this.
8788

8889
#Downloading and Usage
8990

0 commit comments

Comments
 (0)