diff --git a/README.md b/README.md index 8743c83..45bfa47 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,80 @@ -# raid-bootloader-installer-proxmox +# RAID Bootloader Installation Script +A robust bash script for implementing RAID1 configuration for EFI boot partitions with multiple bootloader support. Designed for enterprise environments and high-availability systems, particularly optimized for Proxmox deployments. + +## Features + +- Multiple bootloader support (GRUB, systemd-boot, rEFInd, Limine, LILO) +- Automatic RAID1 array configuration +- EFI partition backup and restoration +- Comprehensive error handling and logging +- Support for both standard drives and NVMe devices +- Automated bootloader installation across all specified partitions + +## Prerequisites + +- Linux-based system (tested on Debian/Ubuntu) +- Root access +- mdadm package installed +- Supported bootloaders installed (as needed) +- Multiple drives with EFI partitions + +## Installation + +1. Download the script: +```bash +wget https://git.hhf.technology/hhf/raid-bootloader-installer-proxmox/raw/branch/main/raid_bootloader_install.sh +``` + +2. Make the script executable: +```bash +chmod +x raid_bootloader_install.sh +``` + +## Configuration + +Edit the script to specify your EFI partitions: + +```bash +EFI_PARTITIONS=( + "/dev/sdd2" + "/dev/sdb2" + "/dev/nvme2n1p2" + "/dev/sdc2" + "/dev/nvme1n1p2" + "/dev/sda2" +) +``` + +## Usage + +Run the script as root: +```bash +sudo ./raid_bootloader_install.sh +``` + +## Logging + +The script logs all operations to: +- Console output +- /var/log/raid_bootloader_install.log + +## Safety Features + +- Automated backup of EFI contents before operations +- Comprehensive error checking +- Safe mount/unmount operations +- Verification of root privileges + +## Support + +For bugs, feature requests, or support, please create an post in the [forum](https://forum.hhf.technology/t/implementing-raid-boot-configuration-in-proxmox) comments. + + +## License + +MIT License - See LICENSE file for details + +## Disclaimer + +This script modifies boot configurations and RAID arrays. Always backup your data before use. Test in a non-production environment first. \ No newline at end of file