From 0a5f7db9303f9d9b6ce0d3de5101d285252750e0 Mon Sep 17 00:00:00 2001 From: Nick Hepler Date: Fri, 11 Oct 2024 22:58:38 -0400 Subject: [PATCH] Update README. --- README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a4b7ee0..0a91f69 100644 --- a/README.md +++ b/README.md @@ -4,26 +4,26 @@ This Bash script is designed for RHEL-based Linux distributions. It automates th ## Features -- Updates the package manager and upgrades installed packages. -- Sets the system timezone. -- Changes the hostname of the machine. -- Updates the `/etc/hosts` file with the machine's IP address and hostname. -- Modifies SSH configuration for better security: +- **System Updates**: Updates the package manager and upgrades installed packages. +- **Timezone Configuration**: Sets the system timezone. +- **Hostname Change**: Changes the hostname of the machine. +- **Hosts File Update**: Updates the `/etc/hosts` file with the machine's IP address and hostname. +- **SSH Security Enhancements**: - Disables root login. - Disables password authentication. - - Ensures IPv4 address family is not commented out. -- Optionally installs Docker using the official installation script. + - Ensures IPv4 address family is explicitly set. +- **Optional Docker Installation**: Installs Docker CE using the official installation script. ## Prerequisites - A RHEL-based Linux distribution (e.g., CentOS, Fedora). - Root access or sudo privileges. - `dnf` or `yum` package manager. -- `curl` installed (if not present, please install it using your package manager). +- `curl` installed (if not present, install it using your package manager). ## Usage -1. **Clone the repository:** +1. **Clone the repository**: ```bash git clone https://git.nickhepler.cloud/nick/RHELSecureSetup.git @@ -43,12 +43,14 @@ This Bash script is designed for RHEL-based Linux distributions. It automates th ``` 4. **Follow the prompts**: - - Enter your public SSH key when prompted. - - Choose whether to install Docker CE at the end of the script. + - Enter the desired hostname and timezone. + - Provide a username and password for a new limited user account. + - Optionally, choose whether to install Docker CE at the end of the script. ## Customization -- **Time Zone**: Modify the `timezone` variable in the script to set your desired time zone. +- **Time Zone**: Modify the `timezone` variable in the script to set your desired timezone. +- **Hostname**: The script prompts for a hostname during execution, but you can also set a default value in the script. ## License @@ -56,4 +58,4 @@ This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) f ## Acknowledgments -- Inspired by the documentation from Akamai (formerly Linode) for [setting up and securing compute instances](https://techdocs.akamai.com/cloud-computing/docs/set-up-and-secure-a-compute-instance). \ No newline at end of file +- Inspired by documentation from Akamai (formerly Linode) for [setting up and securing compute instances](https://techdocs.akamai.com/cloud-computing/docs/set-up-and-secure-a-compute-instance). \ No newline at end of file