Update README.

This commit is contained in:
Nick Hepler 2024-10-11 22:58:38 -04:00
parent af395f3725
commit 0a5f7db930

View File

@ -4,26 +4,26 @@ This Bash script is designed for RHEL-based Linux distributions. It automates th
## Features ## Features
- Updates the package manager and upgrades installed packages. - **System Updates**: Updates the package manager and upgrades installed packages.
- Sets the system timezone. - **Timezone Configuration**: Sets the system timezone.
- Changes the hostname of the machine. - **Hostname Change**: Changes the hostname of the machine.
- Updates the `/etc/hosts` file with the machine's IP address and hostname. - **Hosts File Update**: Updates the `/etc/hosts` file with the machine's IP address and hostname.
- Modifies SSH configuration for better security: - **SSH Security Enhancements**:
- Disables root login. - Disables root login.
- Disables password authentication. - Disables password authentication.
- Ensures IPv4 address family is not commented out. - Ensures IPv4 address family is explicitly set.
- Optionally installs Docker using the official installation script. - **Optional Docker Installation**: Installs Docker CE using the official installation script.
## Prerequisites ## Prerequisites
- A RHEL-based Linux distribution (e.g., CentOS, Fedora). - A RHEL-based Linux distribution (e.g., CentOS, Fedora).
- Root access or sudo privileges. - Root access or sudo privileges.
- `dnf` or `yum` package manager. - `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 ## Usage
1. **Clone the repository:** 1. **Clone the repository**:
```bash ```bash
git clone https://git.nickhepler.cloud/nick/RHELSecureSetup.git 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**: 4. **Follow the prompts**:
- Enter your public SSH key when prompted. - Enter the desired hostname and timezone.
- Choose whether to install Docker CE at the end of the script. - 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 ## Customization
- **Time Zone**: Modify the `timezone` variable in the script to set your desired timezone. - **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 ## License
@ -56,4 +58,4 @@ This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) f
## Acknowledgments ## 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). - 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).