Update README.md

This commit is contained in:
Kevin Veen-Birkenbach 2025-03-04 19:59:47 +01:00
parent 13454c7e87
commit bf95ba6090
No known key found for this signature in database
GPG Key ID: 44D8F11FD62F878E

View File

@ -1,62 +1,68 @@
# Linux Image Manager
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](./LICENSE.txt)
# Linux Image Manager🖥🛠
This repository contains some shell scripts to download and configure linux images and to transfer them to a storage.
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](./LICENSE.txt) [![GitHub stars](https://img.shields.io/github/stars/kevinveenbirkenbach/linux-image-manager.svg?style=social)](https://github.com/kevinveenbirkenbach/linux-image-manager/stargazers)
## Virtual Btrfs RAID1 Setup
Linux Image Manager(lim) is a powerful collection of shell scripts for downloading, configuring, and managing Linux images. Whether you're setting up encrypted storage, configuring a virtual Btrfs RAID1, performing backups, or chrooting into an image, this tool makes Linux image administration simple and efficient. 🚀
To setup a virtual btrfs encrypted raid 1 execute:
## Features ✨
- **Image Download & Setup:** Automatically download and prepare Linux distributions.
- **Encrypted Storage:** Configure LUKS encryption for secure image management.
- **Virtual RAID1:** Easily set up virtual Btrfs RAID1 for data redundancy.
- **Chroot Environment:** Seamlessly chroot into your Linux image for system maintenance.
- **Backup & Restore:** Comprehensive backup and restore options for system images.
- **Automated Procedures:** Simplify partitioning, formatting, mounting, and more.
## Installation 📦
Install Linux Image Manager quickly with [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager) under the alias `lim`. Just run:
```bash
bash scripts/encryption/storage/raid1/setup.sh
package-manager install lim
```
## Setup
This command makes Linux Image Manager globally available as `lim` in your terminal. 🔧
To install a Linux distribution execute:
## Usage ⚙️
Linux Image Manager comes with a variety of scripts tailored for different tasks. Here are a few examples:
### Virtual Btrfs RAID1 Setup
```bash
sudo bash ./scripts/image/setup.sh
lim raid1/setup.sh
```
### Cleanup
To cleanup the image setup execute:
### Linux Image Setup
```bash
fuser -k /dev/mapper/linux-image-manager-*;
umount -f /dev/mapper/linux-image-manager-*;
fuser -k /tmp/linux-image-manager-*;
umount -f /tmp/linux-image-manager-*;
lim image/setup.sh
```
Additional you can unmount the device with a command like
### Chroot into Linux Image
```bash
umount -f /dev/sd*;
lim image/chroot.sh
```
### Verification
To verify that the unmounting was successfull, check the result of
### Backup Image
```bash
mount
lim image/backup.sh
```
## Chroot
Explore the `scripts/` directory for more functionalities and detailed usage instructions.
To chroot into a Linux distribution on a storage execute:
## Configuration & Customization 🔧
```bash
sudo bash ./scripts/image/chroot.sh
```
Customize your environment in the `configuration/` folder:
- **General Packages:** Common packages for all setup scripts.
- **Server LUKS Packages:** Packages needed for setting up LUKS encryption on servers.
## Backup
## License 📜
To backup a image execute:
This project is licensed under the GNU General Public License Version 3. See the [LICENSE.txt](./LICENSE.txt) file for details.
```bash
sudo bash ./scripts/image/backup.sh
```
## Contact & Support 💬
## License
- **Author:** Kevin Veen-Birkenbach
- **Email:** [kevin@veen.world](mailto:kevin@veen.world)
- **Website:** [https://www.veen.world/](https://www.veen.world/)
The ["GNU GENERAL PUBLIC LICENSE Version 3"](./LICENSE.txt) applies to this project.
Feel free to contribute, report issues, or get in touch. Happy Linux managing! 😊