From ac4964a80a540d82f1e76024cbec516908430dc1 Mon Sep 17 00:00:00 2001 From: buildplan <170122315+buildplan@users.noreply.github.com> Date: Thu, 26 Jun 2025 22:52:15 +0100 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ad5168e..9cdfd81 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ --- -## ๐Ÿ“Œ Overview +## Overview This script automates the initial setup and security hardening of a fresh Debian or Ubuntu server. It is designed to be **idempotent**, **safe**, and suitable for **production environments**, establishing a secure baseline from which to build upon. @@ -18,7 +18,7 @@ It runs interactively, guiding the user through critical choices while automatin --- -## โœจ Features +## Features - **Secure User Management:** Creates a new administrator user with `sudo` privileges and disables the root account's SSH access. - **SSH Hardening:** Configures the SSH server to use a custom port, disable password authentication (enforcing key-based login), and apply other security best practices. @@ -35,7 +35,7 @@ It runs interactively, guiding the user through critical choices while automatin --- -## ๐Ÿš€ Installation & Usage +## Installation & Usage ### Prerequisites @@ -46,7 +46,7 @@ It runs interactively, guiding the user through critical choices while automatin ### 1. Download the Script ```bash -wget [https://raw.githubusercontent.com/buildplan/setup_harden_server/refs/heads/main/setup_harden_debian_ubuntu.sh](https://raw.githubusercontent.com/buildplan/setup_harden_server/refs/heads/main/setup_harden_debian_ubuntu.sh) +wget https://raw.githubusercontent.com/buildplan/setup_harden_server/refs/heads/main/setup_harden_debian_ubuntu.sh chmod +x setup_harden_debian_ubuntu.sh ``` @@ -68,7 +68,7 @@ sudo ./setup_harden_debian_ubuntu.sh --quiet --- -## ๐Ÿ—‚๏ธ What It Does in Detail +## What It Does in Detail | Task | Description | | ----------------------- | --------------------------------------------------------------------------- | @@ -86,18 +86,18 @@ sudo ./setup_harden_debian_ubuntu.sh --quiet --- -## ๐Ÿชต Logs & Backups +## Logs & Backups - **Log Files:** `/var/log/setup_harden_debian_ubuntu_*.log` - **Configuration Backups:** `/root/setup_harden_backup_*` --- -## ๐Ÿงช Tested On +## Tested On - Debian 12 -- Ubuntu 24.04 LTS, 22.04 LTS -- Common cloud providers (DigitalOcean, AWS, GCP, Oracle Cloud) and local VMs. +- Ubuntu 24.04 LTS +- Cloud providers (DigitalOcean & Oracle Cloud) and local VMs. --- @@ -110,7 +110,7 @@ sudo ./setup_harden_debian_ubuntu.sh --quiet --- -## ๐Ÿ› ๏ธ Troubleshooting +## Troubleshooting ### SSH Lockout Recovery