diff --git a/README.md b/README.md index 85eddc8..fd06fa5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,60 @@ -# RHELSecureInstanceSetup +# SecureInstanceSetup -**RHELSecureInstanceSetup** is a script designed to set up and secure a compute instance on RHEL-based distributions, specifically tailored for Linode environments. This script ensures that your instance is up-to-date, secure, and ready for use. \ No newline at end of file +## 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. + +## 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. + +## Prerequisites + +- A RHEL-based Linux distribution (e.g., CentOS, Fedora, RHEL). +- Root access or sudo privileges. +- `dnf` or `yum` package manager. + +## Usage + +1. **Clone the repository:** + + ```bash + git clone https://git.nickhepler.cloud/nick/RHELSecureInstanceSetup.git + cd RHELSecureInstanceSetup + ``` + +2. **Make the script executable:** + + ```bash + chmod +x update_system.sh + ``` + +3. **Run the script with root privileges:** + + ```bash + sudo ./update_system.sh + ``` + +4. **Follow the prompts:** + - Enter your public SSH key when prompted. + +## Configuration + +- You can customize the `hostname` and `timezone` variables in the script as needed. + +## 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. + +## 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