Preservation/kaiten-yaki
1
0
Fork 0
mirror of https://github.com/suikan4github/kaiten-yaki.git synced 2025-12-20 02:21:17 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Revise the install.md

Browse source
This commit is contained in:
Suikan 2021-07-02 22:01:15 +09:00
parent 87b1d3846d
commit 2fe693aa72
1 changed files with 19 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

35
INSTALL.md
View file

@ -5,15 +5,13 @@ Installation requires mainly 2 steps.
- Configure the parameters in config.sh. - Configure the parameters in config.sh.
- Run the kaiten-yaki script - Run the kaiten-yaki script
Each script have to be executed as sourced style. For example : You can execute the install script without command line parameter. For example :
```shell ```shell
source ubuntu-kaiten-yaki.sh source ubuntu-kaiten-yaki.sh
``` ```
If you execute these script as independent command style, it will show an error message and terminate the process immediately.
The first stage of the script is preparation like : erasing disk, format partition, and encryption. This is most critical stage of the entire installation process. This part is controlled by the configuration parameter. Thus, you have to edit the config.txt carefully. The first stage of the script is preparation like : erasing disk, format partition, and encryption. This is most critical stage of the entire installation process. This part is controlled by the configuration parameter. Thus, you have to edit the config.txt carefully.
In the second stage, the distribution dependent installer is invoked. That is the Ubiquity/void-installer of Ubuntu/Void linux, respectively. In the second stage, the distribution dependent GUI/TUI installer is invoked from the running script. That is the Ubiquity/void-installer of Ubuntu/Void linux, respectively.
The third stage is easy. There is nothing user can do. Everything is automatic. The third stage is easy. There is nothing user can do. Everything is automatic.
# Installation # Installation
@ -33,16 +31,17 @@ sudo -i
bash bash
xbps-install -Su xbps nano xbps-install -Su xbps nano
``` ```
The nano is editor package to configure the config.txt. The editor choice is up to you. Kaiten-yaki script doesn't use any editor during execution. The nano is editor package to configure the config.txt. The editor choice is up to you. Kaiten-yaki script doesn't have dependency to nano editor.
Then, edit the config.txt. Then, edit the config.txt.
## Configuration parameters ## Configuration parameters
This is very critical part of the installation. The configuration parameters are in the top of the config.sh. Edit these parameters before the installation. This is very critical part of the installation. The configuration parameters are in the the config.sh. Edit these parameters before the installation.
Followings are set of the default settings of the parameters : Followings are the set of the default settings of the parameters :
- Install to **/dev/sda** (DEV). - Install to **/dev/sda** (DEV).
- Erase entire disk (ERASEALL). - Erase entire disk (ERASEALL).
- Overwrite install is disabled.
- In case of EFI firmware, 200MB is allocated to the EFI partition (EFISIZE). - In case of EFI firmware, 200MB is allocated to the EFI partition (EFISIZE).
- Create a logical volume group named "vg1" in the encrypted volume (VGNAME) - Create a logical volume group named "vg1" in the encrypted volume (VGNAME)
- Create a swap logical volume named "swap" in the "vg1". The size is 8GB (LVSWAPNAME,LVSWAPSIZE) - Create a swap logical volume named "swap" in the "vg1". The size is 8GB (LVSWAPNAME,LVSWAPSIZE)
@ -92,16 +91,16 @@ There are several restrictions :
- The LVSWAPNAME must be unique among all installations in a computer. Otherwise, Kaiten-yaki creates an unnecessary logical volume. This is waste of storage resource. - The LVSWAPNAME must be unique among all installations in a computer. Otherwise, Kaiten-yaki creates an unnecessary logical volume. This is waste of storage resource.
- The EFISIZE and the LVSWAPSIZE are refereed during the first distribution installation only. - The EFISIZE and the LVSWAPSIZE are refereed during the first distribution installation only.
- The LVROOTSIZE is the size of a logical volume to create. This is a relative value to the existing free space in the volume group. If you want to install 3 distributions in a computer, you may want to set 33%FREE, 50%FREE, and 100%FREE for the first, second, and third distribution installation, respectively. - The LVROOTSIZE is the size of a logical volume to create. This is a relative value to the existing free space in the volume group. If you want to install 3 distributions in a computer, you may want to set 33%FREE, 50%FREE, and 100%FREE for the first, second, and third distribution installation, respectively.
- The name with "-" is not allowed for the VGNAME, LVROOTNAME, and LVSWAPNAME. I saw some installed doesn't work if "-" in in the name. - The name with "-" is not allowed for the VGNAME, LVROOTNAME, and LVSWAPNAME. I saw some installer doesn't work if "-" in in the name.
## About overwrite install ## About the overwrite-install
The OVERWRITEINSTALL parameter allow you to use an existing logical volume as root volume of the new installation. The OVERWRITEINSTALL parameter allows you to use an existing logical volume as root volume of the new installation.
This is very danger because of the several aspect like, destroying wrong volume and security. But sometimes it is This is very danger because of the several aspect like destroying wrong volume and risk of security. But sometimes it is
very useful. very useful.
For example, if you reboot the system at the end of GUI/TUI installer by mistake, your system will never boot again. For example, assume you are installing a distribution by Kaiten-yaki. If you reboot the system at the end of GUI/TUI installer by mistake, your system will never boot again.
In this case, the overwrite install recycle this "bad" logical volume and let your system boot again. In this case, the overwrite-install can recycle this "bad" logical volume and let your system boot again.
To use the overwrite install, you have to set the as following : To use the overwrite-install, you have to set some parameters as following :
- ERASEALL : 0 - ERASEALL : 0
- OVERWRITEINSTALL : 1 - OVERWRITEINSTALL : 1
@ -110,7 +109,7 @@ And set following parameters as same as previous installation.
- VGNAME - VGNAME
- CRYPTPARTNAME - CRYPTPARTNAME
So, Kaitenyaki will leave the "bad" logical volume and allow you to overwrite it by GUI/TUI installer. So, Kaiten-yaki will leave the "bad" logical volume and allow you to overwrite it by GUI/TUI installer.
## First stage : Setting up the volumes ## First stage : Setting up the volumes
After you set the configuration parameters correctly, execute the following command from the shell. Again, you have to be promoted as root user, and you have to use Bash. After you set the configuration parameters correctly, execute the following command from the shell. Again, you have to be promoted as root user, and you have to use Bash.
@ -145,5 +144,9 @@ At the end of the GUI/TUI installing, do not reboot the system. Click "Continue"
![Void done](image/void_done.png) ![Void done](image/void_done.png)
## Third stage : Finalizing ## Third stage : Finalizing
After GUI/TUI installer quit without rebooting, final part of the install process automatically starts. You can reboot the system, if you see the "Ready to reboot" message on the console. After GUI/TUI installer quit without rebooting, final part of the install process automatically starts.
In this section, Kaiten-yaki put the encryption key of the LUKS volume in to the ramfs initial stage to allow the Linux kernel decrypt the LUKS partition which contains root logical volume. So, system will ask you passphrase only once when GRUB start.
You can reboot the system, if you see the "Ready to reboot" message on the console.