Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pandashaly authored Jan 24, 2024
1 parent f4ed532 commit 4bd2156
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
`# System Tester README
![Screen Shot 2024-01-24 at 12 03 32 AM](https://github.com/pandashaly/Born2BeRoot_tester/assets/146713758/7b9c1635-bb6a-4469-aed7-9bcf69023652)

## Introduction
πŸ” Born to be root can be long, boring, and confusing, making it challenging to grasp the multitude of commands and configurations. In an attempt to better understand the commands, intricacies of system configurations and simplify the evaluation process for myself and other 42 students I created this tester. I hope you find it helpful!
⭐ Stars for this repo are super helpful and appreciated!

![Screen Shot 2024-01-24 at 12 03 32 AM](https://github.com/pandashaly/Born2BeRoot_tester/assets/146713758/ff53d6df-bff7-43e8-aef6-7515298a3792)

πŸ” Born to be root can be long, boring, and confusing, making it challenging to grasp the multitude of commands and configurations. In an attempt to better understand the commands, and intricacies of system configurations and simplify the evaluation process for myself and other 42 students I created this tester. I hope you find it helpful!
⭐ Stars for this repo are super helpful and appreciated! ~ pandashaly

## Usage
πŸš€ This script is designed to test various aspects of your Debian virtual machine setup for BornToBeRoot. It goes through the evaluation checks in order and checks your VM for specific configurations, password policies, services, UFW configuration, and everything needed to pass this project according to the guidelines set by the pdf. Follow the instructions below to run the tester script.
Expand All @@ -14,10 +11,8 @@
```bash
git clone https://github.com/your-username/your-repo.git
`
1. Run the Script:
`sudo bash tester.sh`
2. Follow the On-Screen Instructions: πŸ“‹ The script will guide you through various checks and provide feedback on your system setup.
Expand All @@ -26,7 +21,7 @@ Important Notes
---------------
- Ensure you have administrative privileges to run the script. Use `sudo` as shown in the usage instructions.
- The script is designed for Debian. Ensure your system matches the expected environment.
- The script is designed for Debian OS and won't work for Rocky. Ensure your system matches the expected environment.
Additional Information
----------------------
Expand Down Expand Up @@ -73,6 +68,10 @@ Conclusion
- [x] Add password checks to the tester.
- [x] Extend Bonus section tests
Feel free to contribute or provide feedback to improve this tool! πŸ› οΈπŸš€ The script aims to assess your system setup based on specific criteria. Thank you for using this tester! If you encounter any errors or have suggestions, feel free to contact me or start an issue on GitHub. This tool is tailored for 42 students, and your feedback is crucial. Contributions are welcome if you want to add new tests to the script. Happy testing, and may your system setups be smooth! πŸš€
Feel free to contribute or provide feedback to improve this tool! πŸ› οΈπŸš€
-------------------------------------------------------------------
The script aims to assess your system setup based on the pdf criteria. Thank you for using this tester! If you encounter any errors or have suggestions, feel free to contact me or start an issue on GitHub. This tool is tailored for 42 students, and your feedback is crucial.
Contributions are welcome if you want to add new tests to the script. Happy testing, and may your system setups be smooth! πŸš€
For any questions or issues, contact me - pandashaly. πŸ€–
For any questions or issues, contact me ~ pandashaly. πŸ€–

0 comments on commit 4bd2156

Please sign in to comment.