ollyt3st / bare-metal-router

Bare Metal Router (BMR) is a pure Linux router designed for x86-64 architecture built in YOCTO, offering a robust networking solution. Utilizing the power of the Yocto Project and the RouterShell CLI, BMR provides a customizable and efficient routing platform.

Bare Metal Router (BMR)

The Bare Metal Router (BMR) is a pure Linux router designed for x86-64 architecture, offering a robust networking solution. Utilizing the power of the Yocto Project and the RouterShell command-line interface (CLI), BMR provides a customizable and efficient routing platform.

Features

• Linux Router: BMR is optimized for x86 architecture, harnessing the reliability and flexibility of Linux for networking tasks.

• RouterShell CLI: An interactive command-line interface inspired by IOS, RouterShell provides an intuitive and familiar configuration experience for network administrators.

• Customizable: Leveraging the Yocto Project, users can customize BMR extensively to meet specific networking requirements.

Getting Started

1. Setup Yocto Build Environment

Before building BMR, ensure you have the Ubuntu Yocto build environment set up:

./setup-yocto-env.sh

2. Download and Install Poky (Codename: Scarthgap)

To download and install Poky (Scarthgap) for BMR:

./install-poky.sh

3. Building Bare Metal Router

Use the build script to create the initial BMR image:

./build-bmr.sh

4. Run Bare Metal Router

Verify the functionality of the BMR image using QEMU:

./run-bmr.sh

5. Create Boot Media

Prepare bootable media for BMR:

./create-bmr-boot-media.sh

Documentation

Detailed instructions and information are available in the docs directory.

Contents:

• Installation Guide: Step-by-step instructions for setting up BMR.

• Configuration: Configuring BMR using the RouterShell CLI.

• Customization: Customizing BMR through the Yocto Project.

Contributing

Contributions to BMR are welcome! Whether it's bug fixes, new features, or improvements to documentation, your contributions are valuable.

How to Contribute

1. Fork the Repository: Create your fork of the project on GitHub.
2. Make Changes: Implement your changes or additions locally.
3. Submit a Pull Request: Send your changes to the main repository.
4. Code Review: Your pull request will be reviewed by project maintainers.

Resources

• GitHub Repository: Bare Metal Router Repository
• RouterShell GitHub: RouterShell Repository
• Yocto Project: Official Site
• Poky: Scarthgap Release

License

The Bare Metal Router project is licensed under the MIT License. See the LICENSE file for more details.