Skip to content

Commit 4185dd6

Browse files
committed
docs(README): improve and reformat README
1 parent 49e9e1b commit 4185dd6

1 file changed

Lines changed: 14 additions & 26 deletions

File tree

README.md

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ This repository is a collection of scripts designed to secure/harden Linux-based
1919
- [Individual Script Usage](#individual-script-usage)
2020
- [Post-Installation](#post-installation)
2121
- [Tested On](#tested-on)
22-
- [Troubleshooting](#troubleshooting)
23-
- [Common Issues](#common-issues)
2422
- [Other Resources](#other-resources)
2523
- [Security Auditing Tools](#security-auditing-tools)
2624
- [Additional Hardening Resources](#additional-hardening-resources)
@@ -38,15 +36,20 @@ Below is a list of tools included in this repository.
3836
|-----------|-------------|----------|--------------|-------|
3937
| **[Lynis Installer](auditing/Lynis%20Installer/lynis-installer.bash)** | Download (clone) Lynis, a security auditing tool for Unix-like systems. | Auditing | Git, Internet connection | No root required |
4038
| **[Root Locker](hardening/Root%20Locker/root-locker.bash)** | Locks the root account to prevent direct logins. | Hardening | Root privileges | Preserves sudo access |
41-
| **[SSHD Hardening](hardening/SSHD%20Hardening/harden-sshd.bash)** | Harden OpenSSH server (sshd) per Lynis recommendations. | Hardening | Root privileges | Creates backups; restarts sshd |
42-
| **[UFW Cloudflare](hardening/UFW%20Cloudflare/ufw-cloudflare.bash)** | Configure UFW to only allow HTTP/HTTPS from Cloudflare IP ranges. | Hardening | Root privileges, UFW, Internet connection | **Beta status** |
39+
| **[SSHD Hardening](hardening/SSHD%20Hardening/harden-sshd.bash)** | Harden OpenSSH server (sshd) per Lynis recommendations. | Hardening | Root privileges | Creates backups |
40+
| **[UFW Cloudflare](hardening/UFW%20Cloudflare/ufw-cloudflare.bash)** | Configure UFW to only allow HTTP/HTTPS from Cloudflare IP ranges. | Hardening | Root privileges, UFW, Internet connection | Creates backups |
41+
42+
> [!NOTE]
43+
> All scripts include version information in their headers. Check individual CHANGELOG.md files in each tool's directory for version history and updates.
44+
4345
## Getting Started
4446

4547
### Prerequisites
4648

49+
The following requirements extend to every tool in this repository:
50+
4751
- **Bash**: Version 4.0 or higher
4852
- **Operating System**: Linux-based distribution
49-
- **File Permissions**: Ability to make scripts executable (`chmod +x`)
5053

5154
> [!NOTE]
5255
> Individual scripts may have additional requirements listed in the table above.
@@ -60,9 +63,6 @@ git clone https://github.com/StrangeRanger/linux-security-scripts
6063
cd linux-security-scripts
6164
```
6265

63-
> [!NOTE]
64-
> If you're downloading individual scripts, you may need to make them executable with `chmod +x <script-name>`.
65-
6666
## Usage
6767

6868
### Quick Start
@@ -79,7 +79,10 @@ For users who want to get started immediately:
7979
cd ~/lynis && sudo ./lynis audit system
8080
```
8181

82-
3. **Apply hardening**: Based on the audit results, run the appropriate hardening scripts.
82+
3. **Apply hardening**: Based on the audit results, run the appropriate hardening scripts with root privileges.
83+
84+
> [!CAUTION]
85+
> **Production Environment Warning**: Always test scripts in a non-production environment first. Some scripts modify critical system configurations and may affect system accessibility.
8386
8487
### Individual Script Usage
8588

@@ -95,9 +98,6 @@ You can run any script individually using one of the following methods:
9598
bash [script-name]
9699
```
97100

98-
> [!IMPORTANT]
99-
> Scripts that require root privileges will prompt you or exit with an error if not run with appropriate permissions.
100-
101101
## Post-Installation
102102

103103
After running the hardening scripts:
@@ -112,28 +112,16 @@ After running the hardening scripts:
112112
113113
## Tested On
114114

115-
All of the scripts should work on most, if not all Linux Distributions. With that said, below is a list of Linux Distributions that the scripts have been officially tested and are confirmed to work on.
115+
All of the scripts should work on most, if not all, Linux distributions with Bash v4.0+ installed. With that said, below is a list of Linux distributions that the scripts have been officially tested and are confirmed to work on.
116116

117117
| Distributions | Distro Versions |
118118
| ------------- | ---------------------- |
119119
| Ubuntu | 24.04, 22.04, 20.04 |
120120
| Debian | 11, 10, 9 |
121121

122-
> [!NOTE]
123-
> Scripts should work on most Linux distributions with Bash 4.0+. The above list represents officially tested distributions.
124-
125-
## Troubleshooting
126-
127-
### Common Issues
128-
129-
- **Permission denied**: Ensure you're running scripts with appropriate permissions (sudo for hardening scripts).
130-
- **Git not found**: Install git with your package manager (`apt install git`, `yum install git`, etc.).
131-
- **SSH connection lost**: The SSHD hardening script creates a backup at `/etc/ssh/sshd_config.bak` - you can restore it if needed.
132-
- **UFW conflicts**: If you have existing UFW rules, review them before running the Cloudflare script.
133-
134122
## Other Resources
135123

136-
While this repository has scripts that can help secure Linux, it's not nearly enough to secure the system as much as it needs to be. Below is a list of other resources that you can/should use to help make your system as secure as possible.
124+
Below is a list of additional resources that you can/should use to help make your system as secure as possible.
137125

138126
### Security Auditing Tools
139127

0 commit comments

Comments
 (0)