Update README
This commit is contained in:
parent
339ef48b23
commit
d6337565ec
49
README.md
49
README.md
@ -1,59 +1,58 @@
|
|||||||
# SecureInstanceSetup
|
# RHELSecureSetup
|
||||||
|
|
||||||
## Overview
|
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.
|
||||||
|
|
||||||
**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
|
## Features
|
||||||
|
|
||||||
- Updates the system packages.
|
- Updates the package manager and upgrades installed packages.
|
||||||
- Sets the timezone and hostname.
|
- Sets the system timezone.
|
||||||
- Modifies SSH configuration to enhance security.
|
- Changes the hostname of the machine.
|
||||||
- Updates the `/etc/hosts` file with the instance's IP address and hostname.
|
- Updates the `/etc/hosts` file with the machine's IP address and hostname.
|
||||||
- Prompts for a public SSH key for secure access.
|
- 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
|
## 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.
|
- 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).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
1. **Clone the repository:**
|
1. **Clone the repository:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.nickhepler.cloud/nick/RHELSecureInstanceSetup.git
|
git clone https://git.nickhepler.cloud/nick/RHELSecureSetup.git
|
||||||
cd RHELSecureInstanceSetup
|
cd RHELSecureSetup
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Make the script executable:**
|
2. **Make the script executable**:
|
||||||
|
|
||||||
```bash
|
```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
|
```bash
|
||||||
sudo ./update_system.sh
|
sudo ./setup.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Follow the prompts:**
|
4. **Follow the prompts**:
|
||||||
- Enter your public SSH key when prompted.
|
- 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
|
## License
|
||||||
|
|
||||||
This project is licensed under the GNU General Public License v3.0 or later. See the [LICENSE](LICENSE) file for details.
|
This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for more details.
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes.
|
|
||||||
|
|
||||||
## Acknowledgments
|
## Acknowledgments
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user