Skip to content

Refine README documentation#31

Merged
StrangeRanger merged 1 commit into
mainfrom
dev
May 18, 2026
Merged

Refine README documentation#31
StrangeRanger merged 1 commit into
mainfrom
dev

Conversation

@StrangeRanger
Copy link
Copy Markdown
Owner

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:

  • Updated usage instructions in multiple README.md files (Root Locker, SSHD Hardening, UFW Cloudflare, and Lynis 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]
  • Improved explanations and added clarifications in the verification steps, such as specifying the meaning of the L status for the root account in Root Locker.

Safety and requirements updates:

  • Strengthened safety guidance by removing or revising notes about recovery access in the SSHD Hardening, UFW Cloudflare, and Nginx WAF documentation, and rewording the cautionary note for SSH hardening to emphasize the risk of being locked out. [1] [2] [3] [4]
  • Updated requirements for the Nginx WAF installer to specify that Nginx version 1.24.0 or newer is needed.

Description clarifications:

  • Clarified the purpose of the Root Locker script 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 via sudo.

These changes help ensure users understand how to safely use and verify the scripts, and that they meet the correct prerequisites.

Copilot AI review requested due to automatic review settings May 18, 2026 21:01
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@StrangeRanger StrangeRanger merged commit 5ac50aa into main May 18, 2026
0 of 2 checks passed
@StrangeRanger StrangeRanger review requested due to automatic review settings May 18, 2026 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant