WebFortress is an educational project aimed at creating a straightforward container-based system leveraging Rust's performance and safety features. This project serves as a practical exploration into the fundamentals of containerization and virtualization technologies, simulating a minimalistic version of Docker-like functionality. By developing a basic container system, contributors and learners can gain hands-on experience with the underlying mechanisms that enable containerization, such as namespaces and cgroups, all within the context of Rust's ecosystem. This initiative not only fosters a deeper understanding of operating system concepts but also showcases the versatility of Rust in system-level programming tasks.
- Luis David Garcia (lgarc120@calpoly.edu)
- Paul Jarski (pjarski@calpoly.edu)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Git
- Rust and Cargo
- Python 3 and pip3
The provided setup script will guide you through installing Rust, Cargo, and necessary Python packages if they are not already installed on your system.
NOTE: Development must occur in a Linux environment to make full use of the container, otherwise the program will fail, as it was not developed for any other operating system yet.
To set up your local development environment, follow these steps:
-
Clone the repository
git clone git@github.com:luisdavidgarcia/WebFortress.git cd WebFortress -
Make the setup script executable
chmod +x setup.sh
-
Run the setup script
./setup.sh
This script will install any missing prerequisites (such as Rust and Cargo), set up pre-commit hooks for code quality, and prepare your development environment.
After running the setup, you can start developing immediately. The repository is structured as follows:
src/: Source files for your Rust projects.scripts/: Utility scripts that might be helpful during development.examples/: Examples of how the containers are deployed.
We welcome contributions to this project! Please consider the following steps:
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a pull request.
This project is licensed under the GNU License - see the LICENSE file for details.
We would like to thank Litchi Pi for his great tutorial on creating a container in Rust, which ultimately helped build the foundation for this project.