Commit Graph
126 Commits
Author SHA1 Message Date
Antynea d20a4d62bc docs: relax the awk dependency from gawk to awk
Since #441 the script no longer uses any gawk-specific awk construct.
All of its awk expressions were checked against gawk, mawk, the One True
Awk and busybox awk, and run unmodified on all four.

Declaring gawk advertised a requirement that the script never enforced
and that most users could not satisfy anyway, since mawk is the default
awk on Debian, Ubuntu and derivatives.

Refs #433, #441
2026-08-24 14:56:26 +02:00
Antynea 4a0a27bef1 Fix OpenRC command for adding grub-btrfsd to startup
Fixes #427 
Replace `rc-config add` with `rc-update add` in the README.
2026-05-31 17:55:01 +02:00
cip91sk b509fcaf61 add support for booting snapshots on LUKS encrypted disk (#333)
* add support for booting snapshots on LUKS encrypted disk

* documentation for booting from LUKS encrypted devices

* better detecting cryptdevice UUID
2025-01-06 08:11:45 +01:00
expoodo a8713bbd0b mention yabsnap 2024-02-19 15:12:38 -05:00
Pascal J 99fc835e9c Merge pull request #305 from felixonmars/patch-1
Update Arch Linux package URL in README.md
2024-01-29 10:45:04 +01:00
Yaroslav Halchenko 98a5bbe8c5 [DATALAD RUNCMD] run codespell throughout fixing typo automagically
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
2023-12-21 19:25:13 -05:00
Felix Yan ef150c17bb Update Arch Linux package URL in README.md
The old URL returns 404 now.
2023-11-21 16:42:56 +02:00
Pascal J d51c96433c Remove openrc instructions for updating at system boot/ shutdown 2023-04-13 10:54:03 +02:00
Dan MacDonald f461ea9cf1 More improvements to the README (#276)
* More improvements to the README

* Fix typo in README

* Adjust README according to Pascal's advice
2023-04-13 10:52:24 +02:00
Dan MacDonald 85571aab62 Correct first sentence of README 2023-04-11 08:52:34 +02:00
Dan MacDonald 2bbfddc46a Several edits and tweaks to the README 2023-04-11 08:52:34 +02:00
Pascal Jäger 8105a2edf7 grub-btrfsd: watch more than one snapshot dir
Fix #262

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2023-03-26 21:08:16 +02:00
Pascal Jäger 879bec3697 grub-btrfsd: watch snapshots directory recursively
Fix: #262

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2023-03-26 20:44:50 +02:00
Pascal Jäger 89ef805e81 grub-btrfsd: do no append with += to optional args
This does not work anymore, but it should be similar to the systemd
service file anyway, where things are just written in one line.

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-12-10 22:20:15 +01:00
Pascal Jäger bc167ffe00 Readme: added instructions for --timeshift-old
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-11-26 17:59:38 +01:00
Pascal Jäger 9e34f53ef8 Readme: discribe new version generation
Fix #237

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-11-26 15:03:10 +01:00
Pascal Jäger 1d760ad730 Post release version bump
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-11-23 16:11:45 +01:00
Pascal Jäger 02c3fbb23a Version 4.12
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-11-23 15:58:11 +01:00
Pascal Jäger 13b6df8e9a grub-btrfsd: Add flag for colorless output
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-11-23 15:57:52 +01:00
Pascal Jäger 2186d831cd Readme, Manpages: Improve structure
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-11-23 15:57:10 +01:00
Pascal J 1969132073 Update README.md 2022-11-20 23:13:51 +01:00
Pascal Jäger ead3849613 Readme: make instructions on how to run the script clearer
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-11-20 22:27:38 +01:00
Pascal Jaeger 57687ac0ab general: Update README, better instructions
for Fedora

Fix: #221

Signed-off-by: Pascal Jaeger <pascal.jaeger@leimstift.de>
2022-10-21 08:59:23 +02:00
Pascal Jäger 4580c0fa2c grub-btrfsd: better instructions for daemon config
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
2022-09-05 20:20:47 +02:00
Pascal J 8c8ee200fd general: Formatted Readme a bit 2022-09-02 22:58:31 +02:00
Pascal Jäger 961675ca31 grub-btrfsd: Merge openrc and systemd daemon
Fix #213, Fix #211, Fix #215
2022-09-02 22:57:34 +02:00
Pascal J 14c42b82eb grub-btrfsd: Update README.md, Fix #213
Signed-off-by: Jaeger <Pascal.Jaeger@bode-kassel.com>
2022-09-02 22:57:24 +02:00
Pascal Jäger d54f3d7366 grub-btrfsd: Fix #211 for OpenRC-Daemon 2022-09-02 22:56:44 +02:00
Re4son Kernel 3dc1d89965 Add Kali Linux to README (#201)
Kali Linux added grub-btrfs to its repository. This commit reflects that.
2022-02-16 04:15:44 +01:00
Semnodime fc4a5a8e56 Update README.md (#197)
Reformat, beautify and clarify the README.md and promote consistent wording.
The install section regarding timeshift has changed the most.
2022-01-28 05:27:01 +01:00
Antynea 79ae25ea5d Update installation section
Adds make help
2021-11-29 18:58:09 +01:00
Antynea d9f54afcb7 Update Installation section:
Update Dependencies
2021-11-04 12:26:23 +01:00
Pascal Jäger 66a218356a changed instruction for openrc local service 2021-11-02 16:18:04 +01:00
Pascal Jäger 7dc240faa7 Updated readme to take openRC daemon into consideration 2021-11-02 16:18:04 +01:00
Antynea 9d436adf95 Reworks many things (#174)
#### Script:
* Snapper:
  - Now, the information is retrieved from the info.xml file.

* Timeshift:
  * Now, the information is retrieved from the info.json file.

* Probe informations from device:
  * Add the UUID of the root and boot subvolumes

* Show full path snapshot or only name:
  * Remove, this feature never worked correctly

* Grub-menu:
  * Now displays the following information in separate columns:
    - Date of snapshot
    - Path of snapshot
    - Type/Tags of snapshot if available (snapper/timeshift)
    - Description/Comments of snapshot if available (snapper/timeshift)
  * Possibility to display only the desired information(s) (see config file)
  *  Adds a header for the column title
  * GRUB_BTRFS_PREFIXENTRY is remove

  * Boot partition detection:
    * grub-btrfs is now able to detect if the boot folder/partition is a subvolume
    * GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION should no longer be needed for this case

  * Variables:
    * Rename some variables

  * Header:
    * Update the header to reflect the changes.

#### Config:
* GRUB_BTRFS_PREFIXENTRY:
  * Remove, no longer use

* GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT:
  * Remove, no longer use

* GRUB_BTRFS_TITLE_FORMAT:
  * Shows/Hides "date" "snapshot" "type" "description" in the Grub menu, custom order available.
    Default: ("date" "snapshot" "type" "description")

* GRUB_BTRFS_IGNORE_SNAPPER_TYPE:
  * Rename to GRUB_BTRFS_IGNORE_SNAPSHOT_TYPE
    - Supports both timeshift and snapper tags/type

* GRUB_BTRFS_IGNORE_SNAPPER_DESCRIPTION:
  * Rename to GRUB_BTRFS_IGNORE_SNAPSHOT_DESCRIPTION
    - Supports both snapper and timeshift description/comments

* GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION:
  * grub-btrfs is now able to detect if the boot folder/partition is a subvolume.
  Activating this parameter should no longer be necessary for this case.

* GRUB_BTRFS_SNAPPER_CONFIG:
  * Remove, no longer use

#### Readme:
* Update "What does grub-btrfs v4.xx do" section
  * Adds support for timeshift
2021-10-25 15:47:26 +02:00
Antynea df643361cc Add Gentoo and OpenRC instructions
* Add Gentoo instructions in "Installation :" section.
* Add OpenRC instructions in "Automatically update grub :" section
2021-10-07 16:52:44 +02:00
Antynea 81bde02b03 Update "Installation section"
* Update "Installation section":
  * Adds required dependencies
  * Indicates that the command "update-grub", is an alias to "grub-mkconfig" on Debian-like distributions.
2021-09-22 17:07:44 +02:00
Antynea 83bf1da01e Improves systemd.path unit (#139)
* grub-btrfs.path : improves unit

#### Remember to modify your configuration accordingly.  
Allows the unit to start and stop automatically when the mount point is detected.  
If the mount point is already mounted when the unit is activated `systemctl enable grub-btrfs.path`,  
it will be necessary to start the unit for monitoring to begin `systemctl start grub-btrfs.path`.

- `DefaultDependencies=no`
Prevents systemd from automatically generating `Wants= or Requires= or After=`.
- `Requires=\x2esnapshots.mount`
Ensures unit is started if mount point exists.
- `After=\x2esnapshots.mount`
Unit start after the mounting point exists.
- `BindsTo=\x2esnapshots.mount`
If the mount point is removed, the unit will stop.
- `PathModified=\x2esnapshots.mount`
The monitored folder containing the snapshots.
- `WantedBy=\x2esnapshots.mount`
If the mount point exists, unit start automatically. (only if unit is activated before the mount point is mounted)

* Readme: Update "Automatically update grub" section

Update section following the recent change in the `grub-btrfs.path` unit.  
Add information to be able to update the `grub-btrfs` menu every time the system is restart/shutdown.
2021-02-21 05:26:39 +01:00
Antynea a437b80a35 improves systemd service (#131)
grub-btrfs.service: remove unnecessary path for bash and grub-mkconfig command

readme.md: add warning section to systemd service section

config file: Improves the description of the variable GRUB_BTRFS_MKCONFIG
2021-01-03 14:50:34 +01:00
Antynea d8df766554 Update README.md
* Update link to /initramfs/readme
2020-10-14 15:29:50 +02:00
Antynea 9adce629f7 Boot on read-only snapshot (#115)
* Create a initramfs folder & configuration files
  * create a initramfs folder
  * create Arch Linux folder
  * Add `HOOK/INSTALL` files to generate a custom initrafms for boot on read-only snapshot for Arch Linux.
  * Add readme file to initramfs folder

* Makefile changes
  * Add readme file
  * Add readme file of initramfs-overlayfs
  * Add HOOK/INSTALL files for Arch Linux

* Readme changes
  * Updates the documentation to be able to boot on a read-only snapshot.
  * Redesign readme again.
2020-10-14 15:17:07 +02:00
Antynea c9b605153b Redesign readme (#109)
* Add more information

Add more information.
Due to the redesign of the "Customization" section of the readme file.

* Redesign  customization section

Move information of customization section to config file
2020-09-29 13:39:20 +02:00
Antynea 7e922abefb Update "Automatically update grub" section
Update "Automatically update grub" section.
Correct a mistake.
2020-09-28 00:58:21 +02:00
Antynea d20439554e Update "Automatically update grub" section
Update "Automatically update grub" section.
Trying to make it more understandable.
2020-09-28 00:54:45 +02:00
Antynea ce8261395f Update Automatically update grub section
Timeshift use `/run/timeshift/backup/timeshift-btrfs/snapshots` mountpoint for its snapshots.
Timeshift users must modify the monitoring path:
```
[Path]
PathModified=/.snapshots
```
to
```
[Path]
PathModified=/run/timeshift/backup/timeshift-btrfs/snapshots
```
2020-09-24 02:21:37 +02:00
Antynea 2349282df5 Improved sorting of the subvolumes list (#107)
* Improved sorting of the subvolumes list

Add functionality to sort subvolume list by: rootid,gen,ogen,path
Default: "-rootid" means list snapshot by new ones first
See [Sorting section](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs-subvolume#SUBCOMMAND)
2020-09-16 19:16:18 +02:00
Antynea 041a9c6606 Microcode variable updated (#106)
* Microcode variable updated

* Modifying variable to reflect improved microcode detection

* Update config

Change "GRUB_BTRFS_INTEL_UCODE" to new variable "GRUB_BTRFS_CUSTOM_MICROCODE"

* Update README.md

Change "GRUB_BTRFS_INTEL_UCODE" to new variable "GRUB_BTRFS_CUSTOM_MICROCODE"
2020-09-16 18:25:11 +02:00
Antynea f0382536fb Update README.md
automatic microcode detection: now detects amd microcode
2020-09-16 16:21:54 +02:00
Antynea 6bfdf07bbf Add password protection support for the submenu (#97)
* Add password protection support for the submenu

Grub2 supports superuser and user access using passwords. #95

-Ability to add authorized users.
-Possibility to disable password protection for the submenu.

* Update config

* Update README.md
2020-08-29 18:55:39 +02:00
Antynea a89834248c Update README.md 2020-08-28 04:19:44 +02:00