Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capi-nemoo/easyboot.xyz
https://github.com/capi-nemoo/easyboot.xyz
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/capi-nemoo/easyboot.xyz
- Owner: Capi-nemoo
- Created: 2024-09-14T15:14:49.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T23:48:27.000Z (3 months ago)
- Last Synced: 2024-09-18T04:00:01.995Z (3 months ago)
- Language: HTML
- Size: 6.3 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Welcome to EasyBoot.xyz
First of all, a huge thank you to everyone who showed interest in **EasyBoot.xyz** during HackWest 2024! It was incredibly motivating to hear from so many of you who loved the concept and are excited to try it out or contribute. While the project is still in early development, I'm working hard to implement all the core features, and your support means a lot.
If you're interested in contributing, testing, or just following the progress, feel free to explore the repo, submit issues, or open a pull request. I can't wait to see where this project goes with the help of the amazing open-source community!
## EasyBoot.xyz
EasyBoot.xyz Besides being a personal project, this is also my first project in a hackathon !!! I started developing it with the collaboration of @Iuke-thrutchlley, and @GraysenGould (Graysen Gould). It aims to make installing and customizing Linux distributions less of a hassle. I got tired of setting up the same configs over and over, and thought there had to be an easier way to automate it—especially for people who manage multiple systems or just want a smoother experience. The idea is to automate deployments using PXE boot and virtualization. I’m using tools like Netboot.xyz, iPXE, and Ventoy to make customization and installation simpler for both everyday users and larger setups.
## Features
- PXE boot server for automated OS deployment.
- Custom ISO creation and deployment with **Ventoy**.
- Basic web interface for customization and control.
## Installation
### Prerequisites
To set up **EasyBoot.xyz**, you'll need the following tools installed on your system:
- **Node.js** ()
- **npm** (for package management)
- **Docker** (for containerized services)
- **Netboot.xyz** (for PXE booting)
- **pFsense** (Partially implemented)
### Steps
1. Clone the repository:
```bash
git clone https://github.com/your-username/EasyBoot.xyz.git
cd EasyBoot.xyz
```
2. Install backend dependencies:
```bash
cd backend
npm install
```
3. Set up Docker for containerized services:
```bash
sudo docker-compose up
```
4. Configure **Netboot.xyz**:
- Follow the instructions in the `netboot-setup/` folder for configuring **Netboot.xyz** on your network.
5. Set up **pFsense** (Partially implemented):
- Ensure **pFsense** is installed and configured. Documentation can be found [here](https://www.pfsense.org/docs/).
> **Note**: **Ansible** is not yet implemented.
## Usage
1. Start the application:
```bash
npm start
```
2. Access the web interface at `http://localhost:3000`. From here, you can configure the deployment options, including:
- Custom ISO selection.
- Pre-configured settings for automated installations.
## Development
### Project Structure
- **/backend**: Node.js backend for managing the web interface and API calls.
- **/frontend**: Web interface built with JavaScript and some basic HTML/CSS.
- **/docker**: Docker configurations for various containerized services.
- **/netboot-setup**: Configuration files for **Netboot.xyz**.
#### Not Yet Implemented:
- **/ansible**: Ansible playbooks for system configurations.
- **/pfsense**: Router virtualization setup.
### To Do
- [ ] Finish automating the PXE server setup.
- [ ] Improve the web interface for easier use.
- [ ] Add customization options for ISO installations.
- [ ] Fully integrate Ansible (Not implemented yet).
- [ ] Fix networking and DHCP issues.
### Contributing
Feel free to contribute to the project by submitting issues or pull requests. Please follow the contribution guidelines.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For questions or collaboration, feel free to reach out via email or open an issue in the repository.