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.
This commit is contained in:
Antynea
2020-10-14 15:17:07 +02:00
committed by GitHub
parent 3c5e741641
commit 9adce629f7
5 changed files with 97 additions and 20 deletions

View File

@@ -9,18 +9,18 @@ This is a version 4.xx of grub-btrfs
### Description
Improves Grub by adding "btrfs snapshots" to the Grub menu.
You can start your system on a "snapshot" from the Grub menu.
You can start your system on a "snapshot" from the Grub menu.
Supports manual snapshots, snapper, timeshift ...
##### Warning: booting on read-only snapshots can be tricky
If you choose to do it, `/var/log` must be on a separate subvolume.
Otherwise, make sure your snapshots are writeable.
If you choose to do it, `/var/log` or even `/var` must be on a separate subvolume.
Otherwise, make sure your snapshots are writeable.
See [this ticket](https://github.com/Antynea/grub-btrfs/issues/92) for more info.
This project includes its own solution.
Refer to the [documentation](https://github.com/Antynea/grub-btrfs/blob/boot-read-only-snapshot/initramfs/readme.md).
##
### What does grub-btrfs v4.xx do :
* Automatically List snapshots existing on root partition (btrfs).
@@ -38,19 +38,17 @@ See [this ticket](https://github.com/Antynea/grub-btrfs/issues/92) for more info
pacman -S grub-btrfs
```
### Manual
#### 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.
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`.
You have the possibility to modify many parameters in `/etc/default/grub-btrfs/config`.
See [config file](https://github.com/Antynea/grub-btrfs/blob/master/config) for more information.
##
@@ -58,8 +56,7 @@ See [config file](https://github.com/Antynea/grub-btrfs/blob/master/config) for
If you would like Grub to automatically update when a snapshot is made or deleted:
* Use `systemctl start/enable grub-btrfs.path`.
* `grub-btrfs.path` automatically (re)generates `grub.cfg` when a modification appears in `/.snapshots` folder (by default).
* If your snapshots aren't mounted in `/.snapshots`, you must modify the watch folder using `systemctl edit grub-btrfs.path`.
* If your snapshots aren't mounted in `/.snapshots`, you must modify the watch folder using `systemctl edit grub-btrfs.path`.
* For example: Timeshift mount its snapshots in `/run/timeshift/backup/timeshift-btrfs/snapshots` folder.
Use `systemctl edit grub-btrfs.path`.
@@ -74,11 +71,5 @@ If you would like Grub to automatically update when a snapshot is made or delete
##
### Special thanks for assistance and contributions
* [maximbaz](https://github.com/maximbaz)
* [crossroads1112](https://github.com/crossroads1112)
* [penetal](https://github.com/penetal)
* [wesbarnett](https://github.com/wesbarnett)
* [Psykar](https://github.com/Psykar)
* [anyc](https://github.com/anyc)
* [daftaupe](https://github.com/daftaupe)
* [N-Parsons](https://github.com/N-Parsons)
* [All contributors](https://github.com/Antynea/grub-btrfs/graphs/contributors)
##