Update README

This commit is contained in:
Nick Hepler 2024-10-10 16:27:19 -04:00
parent 339ef48b23
commit d6337565ec

View File

@ -1,59 +1,58 @@
# SecureInstanceSetup
# RHELSecureSetup
## Overview
**SecureInstanceSetup** is a script designed to set up and secure a compute instance on RHEL-based distributions. This script ensures that your instance is up-to-date, secure, and ready for use.
This Bash script is designed for RHEL-based Linux distributions. It automates the process of updating the system, configuring security settings, and optionally installing Docker CE.
## Features
- Updates the system packages.
- Sets the timezone and hostname.
- Modifies SSH configuration to enhance security.
- Updates the `/etc/hosts` file with the instance's IP address and hostname.
- Prompts for a public SSH key for secure access.
- 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:
- Disables root login.
- Disables password authentication.
- Ensures IPv4 address family is not commented out.
- Optionally installs Docker using the official installation script.
## Prerequisites
- A RHEL-based Linux distribution (e.g., CentOS, Fedora, RHEL).
- 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).
## Usage
1. **Clone the repository:**
```bash
git clone https://git.nickhepler.cloud/nick/RHELSecureInstanceSetup.git
cd RHELSecureInstanceSetup
git clone https://git.nickhepler.cloud/nick/RHELSecureSetup.git
cd RHELSecureSetup
```
2. **Make the script executable:**
2. **Make the script executable**:
```bash
chmod +x update_system.sh
chmod +x setup.sh
```
3. **Run the script with root privileges:**
3. **Run the script with root privileges**:
```bash
sudo ./update_system.sh
sudo ./setup.sh
```
4. **Follow the prompts:**
4. **Follow the prompts**:
- Enter your public SSH key when prompted.
- Choose whether to install Docker CE at the end of the script.
## Configuration
## Customization
- You can customize the `hostname` and `timezone` variables in the script as needed.
- **Time Zone**: Modify the `timezone` variable in the script to set your desired time zone.
## License
This project is licensed under the GNU General Public License v3.0 or later. See the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes.
This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for more details.
## Acknowledgments