mirror of
https://github.com/Antynea/grub-btrfs.git
synced 2026-08-22 15:43:14 +08:00
Compare commits
18 Commits
fix-bashis
...
aeda46c2a0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
aeda46c2a0 | ||
|
|
8fb00c532a | ||
|
|
97ae2976f9 | ||
|
|
86345e0d38 | ||
|
|
5b567255e3 | ||
|
|
a181e2ca41 | ||
|
|
a79c9cc42c | ||
|
|
88e8b4ae97 | ||
|
|
004fe0aae4 | ||
|
|
828f593f6f | ||
|
|
b8e6deaafd | ||
|
|
7e8a45ca9c | ||
|
|
14fa71c994 | ||
|
|
2fcfbe9676 | ||
|
|
9e171282da | ||
|
|
b509fcaf61 | ||
|
|
f682e17b30 | ||
|
|
ece8d87151 |
33
.github/workflows/bump-version-on-merge.yml
vendored
Normal file
33
.github/workflows/bump-version-on-merge.yml
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
name: Bump version on merge
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
bump-version:
|
||||
name: Bump version in config
|
||||
runs-on: ubuntu-latest
|
||||
if: github.actor != 'github-actions[bot]'
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
ref: master
|
||||
|
||||
- name: Update version in config
|
||||
run: |
|
||||
version="$(git rev-parse --abbrev-ref HEAD)-$(date -u -Iseconds)"
|
||||
sed -i "s/GRUB_BTRFS_VERSION=.*/GRUB_BTRFS_VERSION=${version}/" config
|
||||
|
||||
- name: Commit updated config
|
||||
run: |
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git add config
|
||||
git commit -m "chore: bump version to ${version}"
|
||||
git push origin master
|
||||
32
.github/workflows/bump-version.yml
vendored
Normal file
32
.github/workflows/bump-version.yml
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
name: Bump version on tag
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
bump-version:
|
||||
name: Bump version in config
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
ref: master
|
||||
|
||||
- name: Update version in config
|
||||
run: |
|
||||
version="${{ github.ref_name }}"
|
||||
sed -i "s/GRUB_BTRFS_VERSION=.*/GRUB_BTRFS_VERSION=${version}/" config
|
||||
|
||||
- name: Commit updated config
|
||||
run: |
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git add config
|
||||
git commit -m "chore: bump version to ${version}"
|
||||
git push origin master
|
||||
@@ -107,20 +107,85 @@ esac
|
||||
if [ -n "${GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS}" ] ; then
|
||||
protection_authorized_users="--users ${GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS} "
|
||||
fi
|
||||
|
||||
## Probe information of Root and Boot devices
|
||||
# Probe info "Root partition"
|
||||
root_device=$(${grub_probe} --target=device /) # Root device
|
||||
root_uuid=$(${grub_probe} --device ${root_device} --target="fs_uuid" 2>/dev/null) # UUID of the root device
|
||||
root_uuid_subvolume=$(btrfs subvolume show / 2>/dev/null) || print_error "UUID of the root subvolume is not available"; # If UUID of root subvolume is not available, then exit
|
||||
root_uuid_subvolume=$(awk -F":" 'match($1, /(^[ \t]+UUID)/) {sub(/^[ \t]+/, "", $2); print $2}' <<< "$root_uuid_subvolume") # UUID of the root subvolume '
|
||||
# Probe info "Boot partition"
|
||||
boot_device=$(${grub_probe} --target=device ${boot_directory}) # Boot device
|
||||
boot_uuid=$(${grub_probe} --device ${boot_device} --target="fs_uuid" 2>/dev/null) # UUID of the boot device
|
||||
boot_uuid_subvolume=$(btrfs subvolume show "$boot_directory" 2>/dev/null) || boot_uuid_subvolume=" UUID: $root_uuid_subvolume"; # If boot folder isn't a subvolume, then UUID=root_uuid_subvolume
|
||||
boot_uuid_subvolume=$(awk -F":" 'match($1, /(^[ \t]+UUID)/) {sub(/^[ \t]+/, "", $2); print $2}' <<< "$boot_uuid_subvolume") # UUID of the boot subvolume '
|
||||
boot_hs=$(${grub_probe} --device ${boot_device} --target="hints_string" 2>/dev/null) # hints string
|
||||
boot_fs=$(${grub_probe} --device ${boot_device} --target="fs" 2>/dev/null) # Type filesystem of boot device
|
||||
# -----------------------------------------------------------
|
||||
|
||||
# ---------- Root partition ----------
|
||||
root_device="$(${grub_probe} --target=device /)" # e.g. /dev/mapper/enc
|
||||
root_uuid="$(${grub_probe} --device "${root_device}" --target=fs_uuid 2>/dev/null)" || true
|
||||
|
||||
# Fallback when grub-probe fails (encrypted container, detached header…)
|
||||
if [ -z "$root_uuid" ]; then
|
||||
root_uuid="$(blkid -s UUID -o value "${root_device}" 2>/dev/null)"
|
||||
fi
|
||||
[ -z "$root_uuid" ] && print_error "Cannot determine UUID of ${root_device}"
|
||||
|
||||
# Root subvolume UUID
|
||||
root_uuid_subvolume="$(btrfs subvolume show / 2>/dev/null | \
|
||||
awk -F':' '/^\s*UUID/ {gsub(/^[ \t]+/, "", $2); print $2}')"
|
||||
[ -z "$root_uuid_subvolume" ] && print_error "UUID of the root subvolume is not available"
|
||||
|
||||
# ---------- Boot partition ----------
|
||||
boot_device="$(${grub_probe} --target=device "${boot_directory}")" # e.g. /dev/sdb1
|
||||
boot_uuid="$(${grub_probe} --device "${boot_device}" --target=fs_uuid 2>/dev/null)" || true
|
||||
|
||||
# Fallback for boot UUID
|
||||
if [ -z "$boot_uuid" ]; then
|
||||
boot_uuid="$(blkid -s UUID -o value "${boot_device}" 2>/dev/null)"
|
||||
fi
|
||||
[ -z "$boot_uuid" ] && print_error "Cannot determine UUID of ${boot_device}"
|
||||
|
||||
# If /boot is not a Btrfs subvolume, reuse root subvol UUID
|
||||
boot_uuid_subvolume="$(
|
||||
btrfs subvolume show "${boot_directory}" 2>/dev/null | \
|
||||
awk -F':' '/^\s*UUID/ {gsub(/^[ \t]+/, "", $2); print $2; exit}'
|
||||
)"
|
||||
[ -z "$boot_uuid_subvolume" ] && boot_uuid_subvolume="$root_uuid_subvolume"
|
||||
|
||||
# Extra data for GRUB commands
|
||||
boot_hs="$(${grub_probe} --device "${boot_device}" --target=hints_string 2>/dev/null)"
|
||||
boot_fs="$(${grub_probe} --device "${boot_device}" --target=fs 2>/dev/null)"
|
||||
# -----------------------------------------------------------
|
||||
|
||||
## Enable LUKS encrypted devices support
|
||||
case "$(echo "$GRUB_BTRFS_ENABLE_CRYPTODISK" | tr '[:upper:]' '[:lower:]')" in
|
||||
true)
|
||||
list_insmods=(
|
||||
"insmod gzio"
|
||||
"insmod part_gpt"
|
||||
"insmod cryptodisk"
|
||||
"insmod luks"
|
||||
"insmod gcry_rijndael"
|
||||
"insmod gcry_rijndael"
|
||||
"insmod gcry_sha256"
|
||||
"insmod ${boot_fs}"
|
||||
)
|
||||
|
||||
# Extract the <source> field of cryptdevice=<source>:<name>[:header]
|
||||
crypt_source="$(printf '%s %s\n' "$GRUB_CMDLINE_LINUX_DEFAULT" "$GRUB_CMDLINE_LINUX" \
|
||||
| grep -o -P 'cryptdevice=\K[^:]+' || true)"
|
||||
|
||||
# Turn the source into a UUID that cryptomount -u understands
|
||||
crypt_uuid=""
|
||||
if [[ "$crypt_source" =~ ^UUID=.* ]]; then # already UUID=…
|
||||
crypt_uuid="${crypt_source#UUID=}"
|
||||
elif [[ "$crypt_source" == /dev/* ]]; then # path → resolve → blkid
|
||||
real_dev=$(readlink -f "$crypt_source" 2>/dev/null || true)
|
||||
[ -b "$real_dev" ] && crypt_uuid=$(blkid -s UUID -o value "$real_dev" 2>/dev/null || true)
|
||||
fi
|
||||
|
||||
# Emit the proper cryptomount command
|
||||
if [[ "$crypt_uuid" =~ ^[0-9a-fA-F-]{36}$ ]]; then
|
||||
list_insmods+=("cryptomount -u ${crypt_uuid}")
|
||||
else
|
||||
# last-resort: scan all crypto containers (works but a bit slower)
|
||||
list_insmods+=("cryptomount -a")
|
||||
fi
|
||||
;;
|
||||
*)
|
||||
list_insmods=("insmod ${boot_fs}")
|
||||
;;
|
||||
esac
|
||||
|
||||
## Parameters passed to the kernel
|
||||
kernel_parameters="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT $GRUB_BTRFS_SNAPSHOT_KERNEL_PARAMETERS"
|
||||
@@ -218,13 +283,22 @@ make_menu_entries()
|
||||
if [ x\$feature_all_video_module = xy ]; then
|
||||
insmod all_video
|
||||
fi
|
||||
set gfxpayload=keep
|
||||
insmod ${boot_fs}
|
||||
set gfxpayload=keep"
|
||||
for j in "${insmods[@]}"; do
|
||||
entry "\
|
||||
${j}"
|
||||
done
|
||||
entry "\
|
||||
if [ x\$feature_platform_search_hint = xy ]; then
|
||||
search --no-floppy --fs-uuid --set=root ${boot_hs} ${boot_uuid}
|
||||
else
|
||||
search --no-floppy --fs-uuid --set=root ${boot_uuid}
|
||||
fi"
|
||||
if [ "${SUSE_BTRFS_SNAPSHOT_BOOTING:-"false"}" = "true" ]; then
|
||||
entry "\
|
||||
set btrfs_subvolid=5"
|
||||
fi
|
||||
entry "\
|
||||
echo 'Loading Snapshot: "${snap_date_trim}" "${snap_dir_name_trim}"'
|
||||
echo 'Loading Kernel: "${k}" ...'
|
||||
linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" ${kernel_parameters} ${rootflags}subvol=\""${snap_dir_name_trim}"\""
|
||||
@@ -259,7 +333,12 @@ make_menu_entries()
|
||||
search --no-floppy --fs-uuid --set=root ${boot_hs} ${boot_uuid}
|
||||
else
|
||||
search --no-floppy --fs-uuid --set=root ${boot_uuid}
|
||||
fi"
|
||||
if [ "${SUSE_BTRFS_SNAPSHOT_BOOTING:-"false"}" = "true" ]; then
|
||||
entry "\
|
||||
set btrfs_subvolid=5"
|
||||
fi
|
||||
entry "\
|
||||
echo 'Loading Snapshot: "${snap_date_trim}" "${snap_dir_name_trim}"'
|
||||
echo 'Loading Kernel: "${k}" ...'
|
||||
linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" ${kernel_parameters} ${rootflags}subvol=\""${snap_dir_name_trim}"\""
|
||||
@@ -318,7 +397,7 @@ snapshot_list()
|
||||
# Parse Snapper & timeshift & yabsnap information
|
||||
local type_snapshot="N/A"
|
||||
local description_snapshot="N/A"
|
||||
|
||||
|
||||
# path to yabsnap snapshot meta data
|
||||
local yabsnap_info="$grub_btrfs_mount_point/${path_snapshot%"/"*}/$(echo "${snap[13]}" | awk -F'/' '{print $3 "-meta.json"}')"
|
||||
|
||||
@@ -455,12 +534,8 @@ detect_microcode()
|
||||
list_ucode=()
|
||||
# Original intel/amd microcode (auto-detect)
|
||||
# See "https://www.gnu.org/software/grub/manual/grub/html_node/Simple-configuration.html"
|
||||
for oiucode in "${boot_dir}"/intel-uc.img \
|
||||
"${boot_dir}"/intel-ucode.img \
|
||||
"${boot_dir}"/amd-uc.img \
|
||||
"${boot_dir}"/amd-ucode.img \
|
||||
"${boot_dir}"/early_ucode.cpio \
|
||||
"${boot_dir}"/microcode.cpio; do
|
||||
for oiucode in ${GRUB_EARLY_INITRD_LINUX_STOCK} ; do
|
||||
oiucode="${boot_dir}/${oiucode}"
|
||||
[ ! -f "${oiucode}" ] && continue;
|
||||
list_ucode+=("$oiucode")
|
||||
done
|
||||
@@ -531,6 +606,7 @@ boot_bounded()
|
||||
detect_rootflags
|
||||
title_format
|
||||
boot_dir_root_grub="$(make_system_path_relative_to_its_root "${boot_dir}")" # convert "boot_directory" to root of GRUB (e.g /boot become /)
|
||||
insmods=("${list_insmods[@]##*"/"}")
|
||||
make_menu_entries
|
||||
# show snapshot found during run "grub-mkconfig"
|
||||
if [ "${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}" = "true" ]; then
|
||||
|
||||
@@ -274,6 +274,10 @@ After that, the daemon should be restarted with:
|
||||
sudo rc-service grub-btrfsd restart
|
||||
```
|
||||
|
||||
##### 🔒 Snapshots on LUKS encrypted devices
|
||||
By default, grub-btrfs generates entries that does not load modules for dealing with encrypted devices.
|
||||
Enable the `GRUB_BTRFS_ENABLE_CRYPTODISK` variable in `/etc/default/grub-btrfs/config` to load said modules and then execute the steps to mount encrypted root after selecting the snapshot.
|
||||
|
||||
- - -
|
||||
### Troubleshooting
|
||||
If you experience problems with grub-btrfs don't hesitate [to file an issue](https://github.com/Antynea/grub-btrfs/issues/new/choose).
|
||||
|
||||
16
config
16
config
@@ -1,7 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
|
||||
GRUB_BTRFS_VERSION=4.13-yabsnap_info_support-2024-03-06T13:43:57+00:00
|
||||
GRUB_BTRFS_VERSION=master-2026-05-22T11:33:41+00:00
|
||||
|
||||
# Distribution specific auto-detection (e.g. Fedora)
|
||||
if [ -f /etc/fedora-release ]; then
|
||||
GRUB_BTRFS_GRUB_DIRNAME="/boot/grub2"
|
||||
GRUB_BTRFS_GBTRFS_DIRNAME="/boot/grub2"
|
||||
GRUB_BTRFS_MKCONFIG="grub2-mkconfig"
|
||||
GRUB_BTRFS_SCRIPT_CHECK="grub2-script-check"
|
||||
fi
|
||||
|
||||
# Disable grub-btrfs.
|
||||
# Default: "false"
|
||||
@@ -74,7 +82,7 @@ GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("@")
|
||||
# Any path starting with the specified string will be ignored.
|
||||
# e.g : if `prefix path` = @, all snapshots beginning with "@/..." will be ignored.
|
||||
# Default: ("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")
|
||||
GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/docker")
|
||||
GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/docker" "var/lib/containers" "@var/lib/containers" "@/var/lib/containers")
|
||||
|
||||
# Ignore specific type/tag of snapshot during run "grub-mkconfig".
|
||||
# For snapper:
|
||||
@@ -158,3 +166,7 @@ GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/doc
|
||||
# doesn't work if GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS isn't empty
|
||||
# Default: "false"
|
||||
#GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU="true"
|
||||
|
||||
# Enable booting from snapshots stored on LUKS encrypted devices
|
||||
# Default: "false"
|
||||
#GRUB_BTRFS_ENABLE_CRYPTODISK="true"
|
||||
|
||||
@@ -102,6 +102,14 @@ Default: “false”
|
||||
.IP \(em 4
|
||||
Example: \fCGRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="true"\fP
|
||||
|
||||
.SS "\GRUB_BTRFS_ENABLE_CRYPTODISK\fP"
|
||||
.PP
|
||||
Enable booting from snapshots stored on LUKS encrypted devices
|
||||
.IP \(em 4
|
||||
Default: “false”
|
||||
.IP \(em 4
|
||||
Example: \GRUB_BTRFS_ENABLE_CRYPTODISK="true"\fP
|
||||
|
||||
.SS "CUSTOM KERNELS"
|
||||
.SS "\fCGRUB_BTRFS_NKERNEL\fP / \fCGRUB_BTRFS_NINIT\fP / \fCGRUB_BTRFS_CUSTOM_MICROCODE\fP"
|
||||
.PP
|
||||
|
||||
@@ -73,6 +73,11 @@ Change to "true" if your boot partition is not detected as separate.
|
||||
- Default: "false"
|
||||
- Example: ~GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="true"~
|
||||
|
||||
*** ~GRUB_BTRFS_ENABLE_CRYPTODISK~
|
||||
Enable booting from snapshots stored on LUKS encrypted devices
|
||||
- Default: "false"
|
||||
- Example: ~GRUB_BTRFS_ENABLE_CRYPTODISK="true"~
|
||||
|
||||
** CUSTOM KERNELS
|
||||
|
||||
*** ~GRUB_BTRFS_NKERNEL~ / ~GRUB_BTRFS_NINIT~ / ~GRUB_BTRFS_CUSTOM_MICROCODE~
|
||||
|
||||
Reference in New Issue
Block a user