Automatic install script for The Linux kernel
Inspired by LinuxKernelBuild
Use-case profiles, CachyOS source + BORE, Clang LTO, CPU tuning, named kernels, and QEMU boot verification.
- Use-case profiles —
--profile desktop|workstation|gaming|server|laptopapplies HZ/preempt/MGLRU/BBR/cgroup settings for the workload. - CachyOS source + BORE —
--source cachyos --sched borebuilds the pinned CachyOS 7.3.4-1 source withCONFIG_CACHYandCONFIG_SCHED_BORE. - CPU tuning —
--cpu generic|native|zen4|x86-64-v3|x86-64-v4.nativeneeds compiler support; with CachyOS’s Rust config it also needs a rustc with APXF support, otherwise usex86-64-v3/zen4. - Clang LTO —
--lto thin|fullwithclang/lld. - Named kernels — automatic localversion (
7.3.4-cachyos-workstation-bore) and--kernel-tag. - Boot verification — QEMU boot smoke test in CI for every distro target.
See Optimization profiles, CachyOS source and BORE, and Kernel naming.
Missing packages are installed when running the script.
# Debian/Ubuntu
wget curl git rsync fakeroot cpio kmod build-essential patch libncurses-dev xz-utils zstd libssl-dev bc lz4 libelf-dev flex bison gawk debhelper dpkg-dev procps apt-transport-https libdw-dev python3 ca-certificates
# Fedora/RHEL
wget curl git rsync ca-certificates procps-ng findutils diffutils hostname bc binutils bison dwarves elfutils-devel elfutils-libelf-devel flex gawk gcc make patch openssl openssl-devel perl python3 ncurses-devel cpio kmod xz lz4 zstd rpm-build dracut grubbygnupg is also installed on demand when tarball verification needs gpg/gpgv, and kexec-tools when --kexec is used.
On Debian-based systems lsb-release is required; the script offers to install it if it is missing.
- This script reverts bug #1086172 Enable more ZRAM compression options by default (kernel 6.12 and newer)
- Sets default compression to zstd (change it with
--default-compression), and enables support for the rest of the algorithms - Options are:
- Sets default compression to zstd (change it with
lz4 compression support (ZRAM_BACKEND_LZ4) [Y/n/?] y
lz4hc compression support (ZRAM_BACKEND_LZ4HC) [Y/n/?] y
zstd compression support (ZRAM_BACKEND_ZSTD) [Y/n/?] y
deflate compression support (ZRAM_BACKEND_DEFLATE) [Y/n/?] y
842 compression support (ZRAM_BACKEND_842) [Y/n/?] y
lzo and lzo-rle compression support (ZRAM_BACKEND_LZO) [Y/n/?] y
Default zram compressor
1. lzo-rle (ZRAM_DEF_COMP_LZORLE)
2. lzo (ZRAM_DEF_COMP_LZO)
3. lz4 (ZRAM_DEF_COMP_LZ4) (NEW)
4. lz4hc (ZRAM_DEF_COMP_LZ4HC) (NEW)
> 5. zstd (ZRAM_DEF_COMP_ZSTD)
6. deflate (ZRAM_DEF_COMP_DEFLATE) (NEW)
7. 842 (ZRAM_DEF_COMP_842) (NEW)Download, review, then run as root:
curl -fsSLO https://github.com/tmiland/kernel-installer/raw/main/kernel_installer.sh
sudo bash kernel_installer.sh # add options as needed, e.g. --stableQuick install with default options:
With Curl:
curl -fsSL https://github.com/tmiland/kernel-installer/raw/main/kernel_installer.sh | sudo bashWith Wget:
wget -qO - https://github.com/tmiland/kernel-installer/raw/main/kernel_installer.sh | sudo bashWith options (e.g. --stable):
curl -fsSL https://github.com/tmiland/kernel-installer/raw/main/kernel_installer.sh | sudo bash -s -- --stableThe installer must run as root: pipe into sudo bash (as above) or run
sudo bash kernel_installer.sh. A run as a regular user exits immediately with a
"must be run as root" error instead of prompting or installing anything.
On systems without sudo, become root first. If the root password is not set:
sudo passwd rootThen:
su rootWhen run outside a git checkout, a pinned and checksum-verified copy of the
function library (src/slib.sh) is fetched automatically.
For latest release
curl -s https://api.github.com/repos/tmiland/kernel-installer/releases/latest \
| grep "browser_download_url.*sh" \
| cut -d : -f 2,3 \
| tr -d \" \
| wget -qi -The release provides kernel_installer.sh and SHA256SUMS; --update verifies the download against the checksum before replacing the script.
For main branch
wget https://github.com/tmiland/kernel-installer/raw/main/kernel_installer.shSet execute permission:
chmod +x kernel_installer.shFor usage, run:
./kernel_installer.sh -hUsage: kernel_installer.sh [options]
If called without arguments, installs stable kernel 7.3.4 using /opt/linux-kernel
--help |-h display this help and exit
--kernel |-k kernel version of choice
--stable |-s stable kernel version 7.3.4
--mainline |-m mainline kernel version 7.4-rc2
--longterm |-l longterm kernel version 6.18.63
--dir |-d install directory
--kexec |-x load new kernel without reboot
--config |-c set configuration target
--custom-config |-cc set custom configuration directive, can be used multiple times
--profile |-p optimization profile (see --list-profiles)
--list-profiles |-lp list optimization profiles and exit
--base-config |-bc profile base config: running, a path, cachyos, or none
--source | kernel source: vanilla (kernel.org) or cachyos (pinned)
--sched | scheduler for the cachyos source: eevdf or bore
--cpu | CPU tuning: generic, native, zen4, x86-64-v3, x86-64-v4
--lto | LTO: none, thin, or full (requires clang/lld)
--hz | timer frequency: 100, 250, 300, 500, 600, 750, 1000
--bbr3 | make BBRv3 the default TCP congestion control (cachyos)
--binder | enable Android Binder IPC and binderfs (Waydroid)
--sched-ext | enable sched_ext and BTF for userspace BPF schedulers
--rt | build a PREEMPT_RT real-time kernel (6.12+)
--hardened | apply the pinned linux-hardened patch (vanilla 7.3.1)
--kernel-tag | custom localversion suffix (default: auto from source/profile)
--verbose |-v increase verbosity
--get-verified-tarball |-gvt cryptographically verify kernel tarball (default)
--nproc |-n set the number of processing units to use
--enable-debug-info |-edi enable debug info
--lowlatency |-low convert generic config to lowlatency
--list-installed |-li list installed kernels
--default-compression |-dc select default compression algorithm
--changelog |-cl view changelog for kernel version
--update |-upd check for a verified script update
--uninstall |-u uninstall kernel (default: running kernel; use -k for another)
Installed kernel version: 7.3.4 | Script version: 1.7.0The versions shown are looked up live from kernel.org each time the script runs.
To use opt --kernel:
./kernel_installer.sh --kernel 5.17.8Else use:
./kernel_installer.sh --stable, --mainline or --longterm separatelyTo use --dir opt:
./kernel_installer.sh --dir /path/to/dirThe source is downloaded and built in a linux-kernel subdirectory (here /path/to/dir/linux-kernel, default /opt/linux-kernel), which is removed after a successful install. The script refuses to use a directory that is not empty unless it created it in a previous run.
The path passed to --dir is the parent. It must be owned by you (or root) and must not be group/other-writable unless it is sticky; the installer creates a missing parent with mode 0700. If it reports Install directory parent ... is writable by group or others, run chmod 700 /path/to/parent or choose a private directory.
To load kernel without reboot:
./kernel_installer.sh --kexecTo use --config:
./kernel_installer.sh --config menuconfigdefault is olddefconfig
As listed by make help in the kernel source (7.3); older kernels may lack some of them.
With the default olddefconfig, the build uses the source tree's current
.config as its base. Profile builds (--profile) default to copying the
running kernel's config (/boot/config-$(uname -r)) first; use
--base-config /path to choose another config, or --base-config none to
keep the historical arch-defconfig behavior.
config - Update current config utilising a line-oriented program
nconfig - Update current config utilising a ncurses menu based program
menuconfig - Update current config utilising a menu based program
xconfig - Update current config utilising a Qt based front-end
gconfig - Update current config utilising a GTK+ based front-end
oldconfig - Update current config utilising a provided .config as base
localmodconfig - Update current config disabling modules not loaded
localyesconfig - Update current config converting local mods to core
defconfig - New config with default from ARCH supplied defconfig
savedefconfig - Save current config as ./defconfig (minimal config)
allnoconfig - New config where all options are answered with no
allyesconfig - New config where all options are accepted with yes
allmodconfig - New config selecting modules when possible
alldefconfig - New config with all symbols set to default
randconfig - New config with random answer to all options
yes2modconfig - Change answers from yes to mod if possible
mod2yesconfig - Change answers from mod to yes if possible
mod2noconfig - Change answers from mod to no if possible
listnewconfig - List new options
helpnewconfig - List new options and help text
olddefconfig - Same as oldconfig but sets new symbols to their default value without prompting
tinyconfig - Configure the tiniest possible kernelProfiles apply a small set of kernel configuration changes for an intended workload. They are starting points, not guarantees: benchmark the result with your own build/game/server workload.
./kernel_installer.sh --list-profiles
./kernel_installer.sh --profile workstation
./kernel_installer.sh --profile server --base-config /boot/config-$(uname -r)
./kernel_installer.sh --profile desktop --base-config noneA profile build uses the running kernel's config as its base by default, so
the resulting kernel keeps the drivers the machine already uses. Use
--base-config /path for another config, or --base-config none to start
from the historical arch defconfig (useful in containers and CI). The
repeatable --custom-config directives are applied after the profile, so they
can override any profile value.
| Profile | Best for | Key settings |
|---|---|---|
desktop |
daily interactive desktop | HZ 1000, full preempt, THP madvise, MGLRU, BBR, O2 |
workstation |
LLM/Android builds plus a responsive desktop | desktop + PSI/cgroup CPU limits, BBR default |
gaming |
latency-sensitive games | desktop timer/preempt settings, O2 |
server |
network/storage throughput | HZ 250, relaxed preempt, MGLRU, BBR default, NR_CPUS 256, O2 |
laptop |
battery and thermals | HZ 300, relaxed preempt, schedutil, AMD/Intel P-state, energy model, MGLRU, O2 |
lowlatency |
audio/live interactive work (legacy alias) | HZ 1000, full preempt, LATENCYTOP; not PREEMPT_RT |
Notes:
-
--lowlatencyis kept as an alias for--profile lowlatency. Combining it with a different--profileis an error. -
The
workstation/serverprofiles enable the cgroup knobs systemd needs (MEMCG,CGROUP_BPF,FAIR_GROUP_SCHED,CFS_BANDWIDTH). Use them with a build slice, for example:systemd-run --user --scope --slice=build.slice \ -p CPUWeight=50 -p IOWeight=50 -p MemoryHigh=75% \ bash -lc 'make -j$(( $(nproc) - 2 ))'The kernel profile reduces scheduler latency; the cgroup is what reserves capacity for the desktop under a sustained build.
-
server/laptopuse relaxed preemption (PREEMPT_LAZYwhere the kernel provides it, otherwise voluntary). On current x86 kernels the oldPREEMPT_NONE/PREEMPT_VOLUNTARYchoices are not both available. -
BBR:
workstation/servermake it the default (DEFAULT_BBR); the other profiles enable the module but leave the default congestion control alone. Usesysctl net.ipv4.tcp_congestion_control=bbrandsysctl net.core.default_qdisc=fqif you want BBR at runtime. -
Not included in the first cut: BORE/CACHY (require the CachyOS patchset), sched_ext (requires
DEBUG_INFO_BTFandpahole, which conflicts with the default debug-info-off build), O3 (not exposed by vanilla 7.3.4; CachyOS carries an out-of-tree O3 option), LTO, and native CPU tuning. These are separate follow-ups.
The CachyOS source tree carries the CachyOS base patchset (CONFIG_CACHY).
It is pinned to 7.3.4-1 and verified with the CachyOS release keys; the
config and BORE patch are pinned by commit and SHA256.
sudo ./kernel_installer.sh -d /path/to/parent \
--source cachyos --sched bore --profile workstation
# resulting kernel release: 7.3.4-cachyos-workstation-bore--source cachyosbuilds the pinned CachyOS source instead of kernel.org. It uses the pinned CachyOS config by default, so--base-config cachyosis implied;--base-config running, a path, ornonestill override it. Version options (--stable,--mainline,--longterm,--kernel) are only accepted if they match the pinned 7.3.4 source.--sched boreapplies the pinned BORE scheduler patch and enablesCONFIG_SCHED_BORE=yplusCONFIG_CACHY=y. It requires--source cachyos: the BORE patch does not apply cleanly to the vanilla kernel.org 7.3.4 tree.--sched eevdfis the default and does not apply the BORE patch.- CI builds and boots the BORE kernel with Clang ThinLTO on Debian 13 and
Ubuntu 24.04, with the
workstationprofile. Native CPU tuning is available but is not part of the default CI matrix because it depends on the build host's toolchain. - Checkout runs verify the CachyOS source with
src/keys/cachyos.asc; piped runs fetch the same pinned fingerprints from keys.openpgp.org. - The CachyOS pins live in
kernel_installer.sh(CACHYOS_*). Update the source tag, PKGBUILD revision, config SHA256, patch revision and patch SHA256 together; a mismatch fails closed. --cpu generic|native|zen4|x86-64-v3|x86-64-v4selects the CPU target.genericis the default and portable.nativeusesX86_NATIVE_CPUand builds for the machine doing the build (it may not boot optimally on another machine).zen4,x86-64-v3, andx86-64-v4require--source cachyos; they use the CachyOSMZEN4/X86_64_VERSIONoptions.--lto none|thin|fullenables Clang LTO.thin/fullinstallclang,lld, andllvmon demand, configureLTO_CLANG_THIN/FULL, and build withLLVM=1 LLVM_IAS=1;noneis the default. The kernel is boot-smoked after the build.- This is the CachyOS base patchset plus BORE, not the full CachyOS variant
matrix. BMQ and the remaining wiki features are separate follow-ups;
sched_ext, PREEMPT_RT, and linux-hardened are available through
--sched-ext,--rt, and--hardened.
Optimized builds get a CONFIG_LOCALVERSION so they are distinguishable in
uname -r, /lib/modules, the headers package, DKMS, initramfs, GRUB and the
.deb names:
<version>-<source>-<profile>[-<scheduler>][-<cpu>][-<lto>][-hz<n>][-bbr3][-binder][-sched-ext][-rt]
| Build | uname -r |
|---|---|
| CachyOS BORE workstation, generic CPU, no LTO | 7.3.4-cachyos-workstation-bore |
| same + native CPU | 7.3.4-cachyos-workstation-bore-native |
| same + native + ThinLTO | 7.3.4-cachyos-workstation-bore-native-lto |
| same + 600 Hz + BBR3 + Binder + sched_ext | 7.3.4-cachyos-workstation-bore-hz600-bbr3-binder-sched-ext |
| same + PREEMPT_RT | 7.3.4-cachyos-workstation-bore-rt |
| vanilla workstation + linux-hardened | 7.3.1-hardened1-vanilla-workstation |
| CachyOS EEVDF server | 7.3.4-cachyos-server |
| vanilla desktop | 7.3.4-vanilla-desktop |
--kernel-tag <suffix> overrides the generated suffix. The default vanilla
build without a profile stays untagged. CONFIG_LOCALVERSION_AUTO is disabled
for named builds. A new localversion is a new kernel release, so DKMS modules
must be rebuilt for it; the installer warns when dkms status -k <release>
finds no modules. Rebuild them for the named release with:
# use the release printed by the installer
sudo dkms autoinstall -k 7.3.4-cachyos-workstation-bore
# or, after booting that kernel:
sudo dkms autoinstall -k "$(uname -r)"Use the full release for removal, e.g. --uninstall -k "$(uname -r)"
(the default without -k).
These flags are applied after the profile and before --custom-config:
| Option | Effect | Notes |
|---|---|---|
--hz <n> |
CONFIG_HZ=n plus the matching HZ_<n> |
100/250/300/1000 on both sources; 500/600/750 require --source cachyos |
--bbr3 |
BBRv3 as the default TCP congestion control | CachyOS source only; per-socket override remains |
--binder |
Android Binder IPC and binderfs | for Waydroid; already enabled by the CachyOS config |
--sched-ext |
SCHED_CLASS_EXT and BTF |
kernel 6.12+; re-enables debug info, installs dwarves (pahole); heavier build |
--rt |
PREEMPT_RT real-time kernel |
kernel 6.12+; disables dynamic preemption; throughput cost |
--sched-ext does not replace BORE at build time. It enables the sched_ext
class; run a userspace scheduler such as scx_rusty or scx_lavd to attach
one, and stop it to return to the default scheduler. The debug info and BTF
that sched_ext needs increase the build time and vmlinux size.
--rt is the mainline PREEMPT_RT kernel, not the lowlatency profile. It
makes almost the whole kernel preemptible for audio, robotics and industrial
workloads, and costs throughput; use it only when you need deterministic
latency.
--hardened builds vanilla 7.3.1 with the pinned
linux-hardened
v7.3.1-hardened1 patch, after verifying its SHA256:
sudo ./kernel_installer.sh --hardened --profile workstation
# resulting kernel release: 7.3.1-hardened1-vanilla-workstationThe patch sets EXTRAVERSION = -hardened1, so the hardened marker comes from
the kernel version itself. The patch is generated against exactly 7.3.1; it
does not apply to 7.3.4. The
variant is vanilla-only: it cannot be combined with --source cachyos, BORE,
or the CachyOS-only CPU/BBR3/HZ choices. The patch adds hardening defaults
such as CONFIG_SECURITY_PERF_EVENTS_RESTRICT=y; see the linux-hardened
documentation for the full set.
The flags are part of the localversion, so builds that differ only by these
options do not collide in /lib/modules or DKMS:
7.3.4-cachyos-workstation-bore-lto-hz600-bbr3-binder-sched-ext
In order to enable specific kernel configs, one can use --custom-config like the following example:
./kernel_installer.sh --custom-config "scripts/config --set-val CONFIG_DM_VDO m"
The directive must be a scripts/config command; raw CONFIG_* assignments (e.g. CONFIG_DM_VDO=y) are not accepted.
Note that --custom-config can be used multiple times like:
./kernel_installer.sh --custom-config "scripts/config --set-val CONFIG_DM_VDO m" --custom-config "scripts/config --set-val CONFIG_KERNEL_ZSTD y"
scripts/boot-smoke.sh boots the installed kernel in QEMU with a minimal
initramfs and requires a BOOT_SMOKE_OK marker on the serial console. CI runs
it after installation in every distro install job, including the profile
smoke job. It proves that the built kernel image boots; it is not a full-OS
boot or a performance benchmark.
./scripts/boot-smoke.sh --version "$(uname -r)"Requires QEMU, a static C compiler, cpio, and mknod as root (or run it
under fakeroot). Use --timeout to change the 180-second limit.
Stable, longterm and --kernel tarballs are cryptographically verified by default
(--get-verified-tarball is accepted but no longer needed). The sha256sums.asc
file is checked against the kernel.org autosigner key, and the tarball against
the Linus Torvalds / Greg Kroah-Hartman signatures. Checkout runs use the
bundled src/keys/kernel.org.asc; piped runs fetch the keys via WKD.
- Linux kernel releases PGP signatures
- Source script get-verified-tarball
- Installs
gnupgifgpg/gpgvare not available - A throwaway keyring is used by default; set
GNUPGHOME=/pathto reuse one. Keys are selected by exact address and exported by fingerprint (a user ID that merely contains the address is not trusted) - Mainline snapshots from git.kernel.org are not signed and are not verified
To skip verification:
GET_VERIFIED_TARBALL=0 ./kernel_installer.shUsed together:
./kernel_installer.sh --stable --config menuconfig --kexec --dir /path/to/dirWatch install log:
tail -f /var/log/kernel-installer/kernel_installer.log- installation log in
/var/log/kernel-installer/kernel_installer.log(a root-only directory), started fresh on every install; the previous install's log is kept askernel_installer.log.1in the same directory, and--list-installed/--uninstallleave both alone - set
LOGFILEto log somewhere else, e.g.LOGFILE=/root/kernel-build.log ./kernel_installer.sh - when the output is not a terminal (a pipe, a file, CI), the spinner and colors are turned off
- ./src/slib.sh function script is sourced remotely if not found locally
- This script is a combination of functions for spinners, colors and logging
- Source: Spinner: swelljoe/spinner
- Source: Run ok: swelljoe/run_ok
- Source: Slog: swelljoe/slog
- Source: Slib: virtualmin/slib
- This script is a combination of functions for spinners, colors and logging
Full write-up on the blog: https://tmiland.com/kernel-installer/
To uninstall previously installed kernel:
./kernel_installer.sh --uninstall --kernel 5.17.7- The
linux-image-<version>andlinux-headers-<version>packages (Fedora/RHEL:kernel-<version>andkernel-devel-<version>) are removed - On Debian-based systems
aptasks for confirmation; on Fedora/RHEL they are removed without a prompt
Tested and working on: Debian 12/13, Ubuntu 22.04/24.04 and Fedora 44 (see test-install.yml)
- Each CI run uploads the installer log of every distro as a workflow artifact (
kernel-installer-logs-<distro>) on the Actions page
src/slib.sh is a curated subset of virtualmin/slib (tracked via tmiland/slib). Updates are two-phase, and CI enforces the second one on main:
# Phase 1 - vendor the new file (defaults to tmiland/slib@master)
scripts/update-slib.sh
git add src/slib.sh && git commit -m 'chore: update vendored slib.sh' && git push
# Phase 2 - pin the pushed commit (updates SLIB_REV / SLIB_SHA256)
scripts/update-slib.sh --finalize <commit>
git add kernel_installer.sh && git commit -m 'chore: bump slib pin' && git push- Use
--source virtualmin/slibto pull upstream directly. Sync your fork first withgh repo sync tmiland/slib -b master. - Sources contain extra Virtualmin-only helpers and are not lint-clean as-is (e.g.
#!/bin/shshebang); the vendored copy is a trimmed, lint-clean subset. Reviewgit diff src/slib.shand the helper's shellcheck output before committing. - Until phase 2 lands on
main, theslib pinCI job fails (that is the reminder).
- PayPal me
- [BTC] : 33mjmoPxqfXnWNsvy8gvMZrrcG3gEa3YDM
*** Use at own risk ***

