Refine README documentation#31
Merged
Merged
Conversation
Up to standards ✅🟢 Issues
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request makes several improvements to the documentation for hardening and auditing scripts. The main changes clarify usage instructions, improve safety guidance, and specify requirements for the scripts. The updates aim to make the documentation more user-friendly and reduce the risk of misconfiguration.
Documentation improvements:
README.mdfiles (Root Locker,SSHD Hardening,UFW Cloudflare, andLynis Installer) to clarify that scripts can be run from either the repository root or their own directories, providing explicit command examples for both. [1] [2] [3] [4]Lstatus for the root account inRoot Locker.Safety and requirements updates:
SSHD Hardening,UFW Cloudflare, andNginx WAFdocumentation, and rewording the cautionary note for SSH hardening to emphasize the risk of being locked out. [1] [2] [3] [4]Nginx WAFinstaller to specify that Nginx version 1.24.0 or newer is needed.Description clarifications:
Root Lockerscript to specify that it locks the root account password (not all forms of root access), and added a note about the continued possibility of privilege escalation viasudo.These changes help ensure users understand how to safely use and verify the scripts, and that they meet the correct prerequisites.