Brush up the README and INSTALL

This commit is contained in:
Suikan 2021-07-03 14:01:27 +09:00
parent c291e77fd6
commit 3858839105
2 changed files with 56 additions and 55 deletions

View file

@ -1,19 +1,20 @@
# Kaiten-yaki : Yet another full disk encryption for GRUB/Linux
Kaiten-yaki is a script set to help you to make a full disk encryption install to your desktop system.
# Kaiten-yaki: Full disk encryption install script for Linux
Kaiten-yaki is a script set helping to install Linux as full disk encryption to your desktop system. With these scripts, you can install Ubuntu/Void Linux to an encrypted partition easily.
Followings are the list of functionality.
- Support Ubuntu and Void Linux.
The followings are the list of functionalities:
- Ubuntu and Void Linux.
- Install from LiveCD/USB.
- Invoke GUI/TUI installer at the middle of script execution, for the ease of installation.
- Invoke GUI/TUI installer automatically at the middle of script execution, for the ease of installation.
- Automatic detection of BIOS/EFI firmware and create MBR/GPT, respectively.
- Support to install multiple distributions in a LUKS partition.
- The "/boot" is located in the same logical volume with the "/".
- The swap logical volume is located inside encrypted volume.
- Create an EFI partition, if needed.
- Support multiple boot in a LUKS partition.
- The "/boot" is located in the same logical volume as the "/".
- The swap logical volume is located inside the encrypted volume.
- You need to type a passphrase only once in the boot sequence.
With the configuration parameters, you can customize each installation. For example, you can configure the system to have 2, 3 or 4,... distributions in a HDD/SSD, as you want.
With the configuration parameters, you can customize each installation. For example, you can configure the system to have 2, 3, or 4,... distributions in an HDD/SSD, as you want.
Following is the HDD/SSD partitioning plan of these scripts ( In case of BIOS, the disk has MBR and doesn't have EFI partition, while it is depicted here).
Following is the HDD/SSD partitioning plan of these scripts ( In the case of BIOS, the disk has MBR and doesn't have an EFI partition, while it is depicted here).
![Partition Diagram](image/partition_diagram_0.png)
@ -22,7 +23,7 @@ The logical volume size of each Linux distribution (LVROOTSIZE) can be customize
As depicted above, the LVM volume group has only one physical volume.
# Tested environment
These scripts are tested with following environment.
These scripts are tested with the following environment.
- VMWare Workstation 15.5.7 ( EFI/BIOS )
- Ubuntu 20.04.2 amd64 desktop
- Ubuntu Mate 20.04.2 amd64 desktop
@ -31,20 +32,20 @@ These scripts are tested with following environment.
- void-live-x86_64-20210218.iso
# Installation
Start the PC with the LiveCD/LiveUSB of the distribution to install. Download this repository from github, and expand it.
Start the PC with the LiveCD/LiveUSB of the distribution to install. Download this repository from GitHub, and expand it.
Then, go to script directory and follow the procedure in the [INSTALL.md](INSTALL.md)
Then, go to the script directory and follow the procedure in the [INSTALL.md](INSTALL.md)
# Known issues
If you install two or more Void Linux in to the EFI system, only the last one can boot without trouble. This is not the problem of Kaiten-yaki.
If you install two or more Void Linux into the EFI system, only the last one can boot without trouble. This is not the problem of Kaiten-yaki.
# Variants considerations
Ubuntu has several variants ( flavors ). While I have tested only MATE flavor, other flavor may work correctly as far as it uses Ubiquity installer.
Ubuntu has several variants ( flavors ). While I have tested only MATE flavor, other flavors may work correctly as far as it uses Ubiquity installer.
# Acknowledgments
These scripts are based on the script shared on the [myn's diary](https://myn.hatenablog.jp/entry/install-ubuntu-focal-with-lvm-on-luks). That page contains rich information, hint and techniques around the encrypted volume and Ubiquity installer.
These scripts are based on the script shared on [myn's diary](https://myn.hatenablog.jp/entry/install-ubuntu-focal-with-lvm-on-luks). That page contains rich information, hint, and techniques around the encrypted volume and Ubiquity installer.
Also, following documents were very important to study how Void Linux installation works.
Also, the following documents were very important to study how Void Linux installation works.
- [Full Disk Encryption](https://docs.voidlinux.org/installation/guides/fde.html) in the Void Handbook.
- [Install LVM LUKS](https://wiki.voidlinux.org/Install_LVM_LUKS) (deprecated)
# Kaiten-yaki