https://github.com/alexmllo/sysadmin-helper
Basic CLI tool for Linux System Manager
https://github.com/alexmllo/sysadmin-helper
bash linux shell
Last synced: 2 months ago
JSON representation
Basic CLI tool for Linux System Manager
- Host: GitHub
- URL: https://github.com/alexmllo/sysadmin-helper
- Owner: alexmllo
- Created: 2025-02-05T17:25:22.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-05T17:31:02.000Z (4 months ago)
- Last Synced: 2025-02-05T18:46:58.422Z (4 months ago)
- Topics: bash, linux, shell
- Language: Shell
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sysadmin-helper
## Overview
**sysadmin-helper** is a CLI tool written in Bash for Linux system maintenance. It provides functions for:
- **Monitoring:** Checking CPU, memory, and disk usage.
- **Logs:** Rotating and analyzing log files.
- **Backup:** Creating and restoring backups of important directories.
- **Maintenance:** Performing system updates and cleaning up temporary files.
## Setup
1. **Clone the repository:**
```bash
git clone https://github.com/alexmllo/sysadmin-helper.git
cd sysadmin-helper
```
2. **Make the main script executable:**
```bash
chmod +x bin/sysadmin-helper.sh
```
3. **Configure your environment:**
Edit `conf/sysadmin-helper.conf` to set your desired thresholds, log file locations, backup directories, and package manager.
4. **Run the help command:**
```bash
./bin/sysadmin-helper.sh help
```
## Usage
Use one of the subcommands to execute a specific task:
### Monitor System Health
Display CPU, memory, and disk usage metrics:
```bash
./bin/sysadmin-helper.sh monitor
```
### Manage Logs
- __Rotate Logs:__
Rotate and compress the log file:
```bash
./bin/sysadmin-helper.sh logs rotate
```
- __Analyze Logs:__
Analyze the log file for errors:
```bash
./bin/sysadmin-helper.sh logs analyze
```
### Backup Operations
- __Create a Backup:__
Create a backup of the directories specified in the configuration:
```bash
./bin/sysadmin-helper.sh backup create
```
- __Restore a Backup:__
Restore from a specified backup file to a destination (default is root):
```bash
./bin/sysadmin-helper.sh backup restore /path/to/backup.tar.gz /destination/path
```
### Perform Maintenance
Run routine maintenance tasks such as updating system packages and cleaning temporary files:
```bash
./bin/sysadmin-helper.sh maintain
```
Alternatively, run specific tasks:
```bash
./bin/sysadmin-helper.sh maintain update
./bin/sysadmin-helper.sh maintain cleanup
```
## Configuration
The configuration file (`conf/sysadmin-helper.conf`) includes settings such as:
- __Thresholds for Monitoring:__
```bash
THRESHOLD_CPU=80
THRESHOLD_MEM=80
THRESHOLD_DISK=90
```
- __Log File Location:__
```bash
LOG_FILE="/var/log/sysadmin-helper.log"
```
- __Backup Settings:__
```bash
BACKUP_DIR="/tmp/sysadmin-backups"
BACKUP_SOURCES="/etc,/var/log"
```
- __Maintenance Settings:__
Specify your package manager (e.g., apt, yum):
```bash
PACKAGE_MANAGER="apt"
```