mirror of
https://github.com/Antynea/grub-btrfs.git
synced 2026-03-04 21:15:02 +08:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
2c03d5f9e2 | ||
|
e286bf1a0d | ||
|
091ffc0ae9 | ||
|
28990c45bb | ||
|
|
4c57fcbbf4 | ||
|
|
e1532c0515 | ||
|
|
73a2bd3d32 | ||
|
|
3eb7eb7861 |
@@ -1,7 +0,0 @@
|
||||
[Service]
|
||||
# Set the possible paths for `grub-mkconfig`
|
||||
Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
|
||||
# Load environment variables from the configuration
|
||||
EnvironmentFile=/etc/grub.d/41_snapshots-btrfs_config
|
||||
# Regenerate just '/boot/grub/grub-btrfs.cfg' if it exists, else regenerate the whole grub menu
|
||||
ExecStartPost=/bin/bash -c 'if [ -s "/boot/${GRUB_BTRFS_DIRNAME:-grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-/usr/bin/grub-mkconfig} -o /boot/${GRUB_BTRFS_DIRNAME:-grub}/grub.cfg; fi'
|
||||
@@ -6,30 +6,32 @@
|
||||
# BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
|
||||
# Github: https://github.com/Antynea/grub-btrfs
|
||||
#
|
||||
# Purpose: Include btrfs snapshots at boot options (grub-menu).
|
||||
# Purpose:
|
||||
# Improves Grub by adding "btrfs snapshots" to the Grub menu.
|
||||
# You can start your system on a "snapshot" from the Grub menu.
|
||||
# Supports manual snapshots, snapper ...
|
||||
# Warning : it isn't recommended to start on read-only snapshot
|
||||
#
|
||||
# What this script does:
|
||||
# Simple rollback using snapshots you made previously.
|
||||
# - Automatically List snapshots existing on root partition (btrfs).
|
||||
# - Automatically Detect if "/boot" is in separate partition.
|
||||
# - Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
|
||||
# - Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.
|
||||
# - Automatically Create corresponding "menuentry" in grub.cfg
|
||||
# - Automatically detect snapper and use snapper's snapshot description if available.
|
||||
# - Automatically generate grub.cfg if you use the provided systemd service.
|
||||
#
|
||||
# How to customize it:
|
||||
# - Refer 41_snapshots-btrfs_config for the list of available options and their default values.
|
||||
# - Place your configurations to either /etc/grub.d/41_snapshots-btrfs_config or /etc/default/grub.
|
||||
# Installation:
|
||||
# - Run `make install` or look into Makefile for instructions on where to put each file.
|
||||
#
|
||||
# - Generate grub.cfg (on Arch Linux use grub-mkconfig -o /boot/$grub_directory/grub.cfg)
|
||||
# Customization:
|
||||
# Refer to config for the list of available options and their default values.
|
||||
# Place your configurations to /etc/default/grub-btrfs/config.
|
||||
#
|
||||
# - grub-btrfs automatically generates snapshots entries.
|
||||
# - You will see it appear different entries (e.g : Snapshot: [2014-02-12 11:24:37] my snapshot name overkill)
|
||||
#
|
||||
# Automatically update grub
|
||||
# If you would like grub to automatically update when Snapper timeline snapshots and cleanups occur, simply install 10-update_grub.conf in the following locations:
|
||||
# - /etc/systemd/system/snapper-timeline.service.d/
|
||||
# - /etc/systemd/system/snapper-cleanup.service.d/
|
||||
# Once the configuration files are in place, systemctl daemon-reload should be run to reload the units and make the changes active.
|
||||
# Automatically update Grub
|
||||
# If you would like Grub to automatically update when a snapshots is made or deleted:
|
||||
# - Mount your subvolume which contains snapshots to /.snapshots
|
||||
# - Use systemctl start/enable grub-btrfs.path
|
||||
# grub-btrfs.path will automatically (re)generate grub.cfg when a modification appear in /.snapshots
|
||||
#
|
||||
# Special thanks for assistance and contributions:
|
||||
# - My friends
|
||||
@@ -43,15 +45,15 @@ prefix="/usr"
|
||||
exec_prefix="/usr"
|
||||
datarootdir="/usr/share"
|
||||
sysconfdir="/etc"
|
||||
grub_btrfs_config="${sysconfdir}/grub.d/41_snapshots-btrfs_config"
|
||||
grub_btrfs_config="${sysconfdir}/default/grub-btrfs/config"
|
||||
|
||||
. "${sysconfdir}/default/grub"
|
||||
[[ -f "$grub_btrfs_config" ]] && . "$grub_btrfs_config"
|
||||
. "$datarootdir/grub/grub-mkconfig_lib"
|
||||
. "${sysconfdir}/default/grub"
|
||||
|
||||
######################################
|
||||
### Variables in /etc/default/grub ###
|
||||
######################################
|
||||
###################################################
|
||||
### Variables in /etc/default/grub-btrfs/config ###
|
||||
###################################################
|
||||
## Disable Grub-btrfs (default=active)
|
||||
grub_btrfs_disable=${GRUB_BTRFS_DISABLE:-"false"}
|
||||
[[ "${grub_btrfs_disable}" == "true" ]] && exit 0
|
||||
@@ -98,18 +100,18 @@ export TEXTDOMAIN=grub-btrfs-git
|
||||
export TEXTDOMAINDIR="/usr/share/locale"
|
||||
## Probe info "Boot partition"
|
||||
# Boot device
|
||||
boot_device=$(${grub_probe} --target=device "/boot")
|
||||
boot_device=$(${grub_probe} --target=device /boot)
|
||||
# hints string
|
||||
boot_hs=$(${grub_probe} --device "${boot_device}" --target="hints_string" 2>/dev/null)
|
||||
boot_hs=$(${grub_probe} --device ${boot_device} --target="hints_string" 2>/dev/null)
|
||||
# UUID of the boot partition
|
||||
boot_uuid=$(${grub_probe} --device "${boot_device}" --target="fs_uuid" 2>/dev/null)
|
||||
boot_uuid=$(${grub_probe} --device ${boot_device} --target="fs_uuid" 2>/dev/null)
|
||||
# Type filesystem of boot partition
|
||||
boot_fs=$(${grub_probe} --target="fs" "/boot" 2>/dev/null)
|
||||
boot_fs=$(${grub_probe} --target="fs" /boot 2>/dev/null)
|
||||
## Probe info "Root partition"
|
||||
# Root device
|
||||
root_device=$(${grub_probe} --target=device "/")
|
||||
root_device=$(${grub_probe} --target=device /)
|
||||
# UUID of the root partition
|
||||
root_uuid=$(${grub_probe} --device "${root_device}" --target="fs_uuid" 2>/dev/null)
|
||||
root_uuid=$(${grub_probe} --device ${root_device} --target="fs_uuid" 2>/dev/null)
|
||||
## Parameters passed to the kernel
|
||||
kernel_parameters="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT"
|
||||
## Mount point location
|
||||
@@ -237,11 +239,11 @@ snapshot_list()
|
||||
# Query info from snapper if it is installed
|
||||
type snapper >/dev/null 2>&1
|
||||
if [[ $? -eq 0 ]]; then
|
||||
local snapper_ids=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 2))
|
||||
local snapper_types=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 1))
|
||||
local snapper_ids=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 1))
|
||||
local snapper_types=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 2))
|
||||
|
||||
IFS=$'\n'
|
||||
local snapper_descriptions=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 7))
|
||||
local snapper_descriptions=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | rev | cut -d'|' -f 2 | rev))
|
||||
fi
|
||||
|
||||
IFS=$'\n'
|
||||
@@ -543,6 +545,7 @@ root_grub="$(make_system_path_relative_to_its_root /boot/$grub_directory)"
|
||||
# Make a submenu in GRUB (grub.cfg)
|
||||
cat << EOF
|
||||
submenu '${submenuname}' {
|
||||
search -f --set=root --no-floppy /grub/grub-btrfs.cfg
|
||||
configfile "${root_grub}/grub-btrfs.cfg"
|
||||
}
|
||||
EOF
|
||||
|
||||
14
Makefile
Normal file
14
Makefile
Normal file
@@ -0,0 +1,14 @@
|
||||
PKGNAME ?= grub-btrfs
|
||||
PREFIX ?= /usr
|
||||
|
||||
SHARE_DIR = $(DESTDIR)$(PREFIX)/share
|
||||
LIB_DIR = $(DESTDIR)$(PREFIX)/lib
|
||||
|
||||
.PHONY: install
|
||||
|
||||
install:
|
||||
@install -Dm755 -t "$(DESTDIR)/etc/grub.d/" 41_snapshots-btrfs
|
||||
@install -Dm644 -t "$(DESTDIR)/etc/default/grub-btrfs/" config
|
||||
@install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.service
|
||||
@install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.path
|
||||
@install -Dm644 -t "$(SHARE_DIR)/licenses/$(PKGNAME)/" LICENSE
|
||||
108
README.md
108
README.md
@@ -1,60 +1,60 @@
|
||||
[](https://github.com/Antynea/grub-btrfs)
|
||||
|
||||
[](https://github.com/Antynea/grub-btrfs/releases)
|
||||
|
||||
|
||||
## grub-btrfs
|
||||
|
||||
This is a version 3.xx of grub-btrfs
|
||||
##### BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
|
||||
This is a version 4.xx of grub-btrfs
|
||||
##### BTC donation address: `1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt`
|
||||
##
|
||||
### Description
|
||||
Improves Grub by adding "btrfs snapshots" to the Grub menu.
|
||||
|
||||
grub-btrfs, Include btrfs snapshots at boot options. (grub menu)
|
||||
You can start your system on a "snapshot" from the Grub menu.
|
||||
|
||||
Supports manual snapshots, snapper ...
|
||||
|
||||
##### Warning : it isn't recommended to start on read-only snapshot
|
||||
##
|
||||
### What does grub-btrfs v3.xx do :
|
||||
|
||||
Simple rollback using snapshots you made previously.
|
||||
|
||||
### What does grub-btrfs v4.xx do :
|
||||
* Automatically List snapshots existing on root partition (btrfs).
|
||||
|
||||
* Automatically Detect if "/boot" is in separate partition.
|
||||
|
||||
* Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
|
||||
|
||||
* Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.
|
||||
|
||||
* Automatically Create corresponding "menuentry" in `grub.cfg`
|
||||
* Automatically detect snapper and use snapper's snapshot description if available.
|
||||
* Automatically generate `grub.cfg` if you use the provided systemd service.
|
||||
##
|
||||
### How to customize it:
|
||||
### Installation :
|
||||
#### Arch Linux
|
||||
|
||||
You have the possibility to modify many parameters.
|
||||
Add this lines to /etc/default/grub:
|
||||
```
|
||||
pacman -S grub-btrfs
|
||||
```
|
||||
|
||||
### Manual
|
||||
|
||||
* Run `make install` or look into Makefile for instructions on where to put each file.
|
||||
|
||||
NOTE: Generate your Grub menu after installation for the changes to take effect. (on Arch Linux use `grub-mkconfig -o /boot/grub/grub.cfg`)
|
||||
##
|
||||
### Customization:
|
||||
|
||||
You have the possibility to modify many parameters in `/etc/default/grub-btrfs/config`.
|
||||
|
||||
* GRUB_BTRFS_SUBMENUNAME="Arch Linux Snapshots"
|
||||
|
||||
(Name menu appearing in grub.)
|
||||
(Name appearing in the Grub menu.)
|
||||
|
||||
* GRUB_BTRFS_PREFIXENTRY="Snapshot:"
|
||||
|
||||
(Add a name ahead your snapshots entries.)
|
||||
(Add a name ahead your snapshots entries in the Grub menu.)
|
||||
|
||||
* GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"
|
||||
|
||||
(Show full path snapshot or only name, weird reaction with snapper)
|
||||
(Show full path snapshot or only name in the Grub menu, weird reaction with snapper)
|
||||
|
||||
* GRUB_BTRFS_TITLE_FORMAT="p/d/n"
|
||||
|
||||
(Custom title, shows/hides p"prefix" d"date" n"name" in grub-menu, separator "/", custom order available)
|
||||
|
||||
* GRUB_BTRFS_NKERNEL=("kernel-custom")
|
||||
|
||||
(Use it only if you have a custom kernel name)
|
||||
|
||||
* GRUB_BTRFS_NINIT=("initramfs-custom.img" "initrd.img-custom")
|
||||
|
||||
(Use it only if you have a custom initramfs name)
|
||||
|
||||
* GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
|
||||
|
||||
(Use it only if you have custom intel-ucode)
|
||||
(Custom title, shows/hides p"prefix" d"date" n"name" in the Grub menu, separator "/", custom order available)
|
||||
|
||||
* GRUB_BTRFS_LIMIT="50"
|
||||
|
||||
@@ -74,6 +74,18 @@ Add this lines to /etc/default/grub:
|
||||
|
||||
(Show Total number of snapshots found during run "grub-mkconfig")
|
||||
|
||||
* GRUB_BTRFS_NKERNEL=("kernel-custom")
|
||||
|
||||
(Use it only if you have a custom kernel name)
|
||||
|
||||
* GRUB_BTRFS_NINIT=("initramfs-custom.img" "initrd.img-custom")
|
||||
|
||||
(Use it only if you have a custom initramfs name)
|
||||
|
||||
* GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
|
||||
|
||||
(Use it only if you have custom intel-ucode)
|
||||
|
||||
* GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")
|
||||
|
||||
(Ignore specific path during run "grub-mkconfig")
|
||||
@@ -82,44 +94,28 @@ Add this lines to /etc/default/grub:
|
||||
|
||||
(Snapper's config name to use)
|
||||
|
||||
* GRUB_BTRFS_DISABLE="true"
|
||||
* GRUB_BTRFS_DISABLE="false"
|
||||
|
||||
(Disable grub-btrfs)
|
||||
|
||||
* GRUB_BTRFS_DIRNAME="grub"
|
||||
|
||||
(Name of the grub folder on /boot/)
|
||||
(Name of the grub folder in `/boot/`, might be grub2 on some distributions )
|
||||
|
||||
* GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="false"
|
||||
(Change to "true" if you have a boot partition in a different subvolume)
|
||||
|
||||
* GRUB_BTRFS_MKCONFIG=grub-mkconfig
|
||||
|
||||
(Name or path of the 'grub-mkconfig' executable; this is 'grub2-mkconfig' on some systems)
|
||||
|
||||
Generate grub.cfg (on Arch linux use grub-mkconfig -o /boot/grub/grub.cfg )
|
||||
|
||||
grub-btrfs automatically generates snapshots entries.
|
||||
|
||||
You will see it appear differents entries (e.g : Snapshot: 2018-01-03 15:08:41 @test1 )
|
||||
(Name or path of the 'grub-mkconfig' executable; might be 'grub2-mkconfig' on some distributions)
|
||||
##
|
||||
### Automatically update grub
|
||||
|
||||
If you would like grub to automatically update when Snapper timeline snapshots and cleanups occur, simply install `10-update_grub.conf` in the following locations:
|
||||
|
||||
- `/etc/systemd/system/snapper-timeline.service.d/`
|
||||
- `/etc/systemd/system/snapper-cleanup.service.d/`
|
||||
|
||||
Or copy `grub-btrfs.path` and `grub-btrfs.service` to `/etc/systemd/system/`
|
||||
|
||||
Once the configuration files are in place, `systemctl daemon-reload` should be run to reload the units and make the changes active.
|
||||
|
||||
##
|
||||
### Discussion
|
||||
Pour les francophones : https://forums.archlinux.fr/viewtopic.php?f=18&t=17177
|
||||
If you would like Grub to automatically update when a snapshots is made or deleted:
|
||||
* Mount your subvolume which contains snapshots to `/.snapshots`
|
||||
* Use `systemctl start/enable grub-btrfs.path`
|
||||
* `grub-btrfs.path` automatically (re)generate `grub.cfg` when a modification appear in `/.snapshots`
|
||||
##
|
||||
### Special thanks for assistance and contributions
|
||||
|
||||
* [maximbaz](https://github.com/maximbaz)
|
||||
* [crossroads1112](https://github.com/crossroads1112)
|
||||
* [penetal](https://github.com/penetal)
|
||||
|
||||
0
grub-btrfs.path
Executable file → Normal file
0
grub-btrfs.path
Executable file → Normal file
2
grub-btrfs.service
Executable file → Normal file
2
grub-btrfs.service
Executable file → Normal file
@@ -6,6 +6,6 @@ Type=oneshot
|
||||
# Set the possible paths for `grub-mkconfig`
|
||||
Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
|
||||
# Load environment variables from the configuration
|
||||
EnvironmentFile=/etc/grub.d/41_snapshots-btrfs_config
|
||||
EnvironmentFile=/etc/default/grub-btrfs/config
|
||||
# Regenerate just '/boot/grub/grub-btrfs.cfg' if it exists and is not empty, else regenerate the whole grub menu
|
||||
ExecStart=/bin/bash -c 'if [ -s "/boot/${GRUB_BTRFS_DIRNAME:-grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-/usr/bin/grub-mkconfig} -o /boot/${GRUB_BTRFS_DIRNAME:-grub}/grub.cfg; fi'
|
||||
|
||||
Binary file not shown.
Reference in New Issue
Block a user