Shell Scripting Overview
Discover the Fundamentals of Shell Scripting with This Comprehensive Overview
Caution - This documentation is in progress
Introduction
Shell script are plain text files containing commands that are interpreted and executed by the shell. They are commonly used for automating tasks, managing system configurations, and performing various operations in Unix-like operating systems.
Usage
Each shell script in this repository is self-contained and can be run directly from the command-line. Before executing a script, ensure that you have the necessary permissions and dependencies installed on your system.
To run a shell script, navigate to its location in the terminal and execute the following command:
./script_name.sh
Replace script_name.sh with the name of the script you want to run.
Shell Scripts
Here’s a brief overview of the scripts available in Homelab-Alpha Shell Script repository. Feel free to explore each script documentation for more details.
audio_converter.sh
Description: This script converts audio files in various formats (m4a, mp3,
wma) to MP3 format with a bitrate of 128k, 44.1kHz sampling rate, and 2-channel
audio.
Detailed Explanation: audio_converter.info
RAW Script: audio_converter.sh
check_pi_throttling.sh
Description: This script checks the throttling status of a Raspberry Pi by
querying the vcgencmd tool.
Detailed Explanation: check_pi_throttling.info
RAW Script: check_pi_throttling.sh
check_system_info.sh
Description: This script checks system information It provides details about
system uptime, hardware information, system temperature, systemctl status,
RAM/SWAP usage, disk usage, disk usage inodes, and last reboot/shutdown events.
Detailed Explanation: check_system_info.info
RAW Script: check_system_info.sh
clearcache.sh
Description: This script drop clean caches, as well as reclaimable slab
objects like dentries and inodes.
Detailed Explanation: clearcache.info
RAW Script: clearcache.sh
cronjob_template.sh
Description: This script is a cronjob template and sends a ping to a
monitoring server for system health check.
Detailed Explanation: cronjob_template.info
RAW Script: cronjob_template.sh
gnome_keybindings_backup_restore.sh
Description: This script allows you to easily create backups of GNOME
keybindings and restore them when needed. It creates a backup directory in the
specified location and saves keybinding configurations for various GNOME
components. You can then choose to make a backup or restore keybindings based on
your preference.
Detailed Explanation: gnome_keybindings_backup_restore.info
RAW Script: gnome_keybindings_backup_restore.sh
gpg_keygen_script.sh
Description: This script generates a GPG key pair for secure communication.
It checks for required software, generates the key pair, and logs the actions.
The script also provides options for verbose output and specifying the GPG
directory.
Detailed Explanation: gpg_keygen_script.info
RAW Script: gpg_keygen_script.sh
install_latest_dart_sass.sh
Description: This script fetches the latest version of Dart Sass from the
official GitHub repository, downloads it, installs it to /usr/local/dart-sass,
and cleans up the downloaded files.
Detailed Explanation: install_latest_dart_sass.info
RAW Script: install_latest_dart_sass.sh
install_latest_go.sh
Description: This script fetches the latest version of Go from the official
Go download page, downloads it, installs it to /usr/local/go, and cleans up the
downloaded files.
Detailed Explanation: install_latest_go.info
RAW Script: install_latest_go.sh
install_latest_hugo.sh
Description: This script fetches the latest version of Hugo from the
official GitHub repository, downloads it, installs it to
/usr/local/hugo-extended, and cleans up the downloaded files.
Detailed Explanation: install_latest_hugo.info
RAW Script: install_latest_hugo.sh
install_latest_jetbrains_mono.sh
Description: The script fetches the latest version of JetBrains Mono from
the official GitHub repository, downloads it, installs it to the system-wide
fonts directory, and cleans up the downloaded files.
Detailed Explanation: install_latest_jetbrains_mono.info
RAW Script: install_latest_jetbrains_mono.sh
maintain_git_repo.sh
Description: This script automates the maintenance process of a Git
repository. It cleans up unnecessary files and resets the commit history to
provide a fresh start, improving repository organization and reducing size. This
can be particularly useful after importing from another version control system
or to ensure a clean history for better project management and collaboration.
Detailed Explanation: maintain_git_repo.info
RAW Script: maintain_git_repo.sh
new_docker_compose_file.sh
Description: This script creates a new Docker-Compose file and configuration
files based on user input.
Detailed Explanation: new_docker_compose_file.info
RAW Script: new_docker_compose_file.sh
new_docker_container.sh
Description: This script creates a new Docker container directory structure
and configuration files based on user input.
Detailed Explanation: new_docker_container.info
RAW Script: new_docker_container.sh
ssh_keygen_script.sh
Description: This script automates the generation and conversion of SSH key
pairs for secure communication. It supports both ed25519 and RSA key types,
allowing users to specify the desired key type, filename for the key pair, and
SSH directory. The script logs all actions and errors to a designated log file
for traceability.
Detailed Explanation: ssh_keygen_script.info
RAW Script: ssh_keygen_script.sh
super_linter.sh
Description: This script facilitates local linting of code repositories
using the Github Super Linter tool. It wraps the Super Linter Docker container,
providing options for linting either a local Git repository or a specific
folder.
Detailed Explanation: super_linter.info
RAW Script: super_linter.sh
uptime_kuma_pr_test_v2.sh
Description: Enables developers to verify pull requests for Uptime-Kuma by
running a Docker container with the specified Uptime-Kuma image on designated
ports for the app and API.
Detailed Explanation: uptime_kuma_pr_test_v2.info
RAW Script: uptime_kuma_pr_test_v2.sh
user_accounts_info.sh
Description: This script retrieves information about system user accounts
and organizes them into system and normal user categories.
Detailed Explanation: user_accounts_info.info
RAW Script: user_accounts_info.sh
Function Scripts
Here’s a brief overview of the function scripts available in Homelab-Alpha Shell Script repository:
cpg.sh
Description: This script provides a function ‘cpg’ to copy files or
directories from a source to a destination. It handles both single files and
directories, including recursive copying.
Detailed Explanation: cpg.info
RAW Script: cpg.sh
dns_check.sh
Description: This script checks network connectivity and DNS server
availability. It does not perform any specific task but can be used to diagnose
network issues.
Detailed Explanation: dns_check.info
RAW Script: dns_check.sh
encrypt_and_decrypt.sh
Description: This script provides functions to encrypt and decrypt files or
directories using AES-256 encryption algorithm with OpenSSL.
Detailed Explanation: encrypt_and_decrypt.info
RAW Script: encrypt_and_decrypt.sh
ex.sh
Description: This script provides a convenient way to extract various
archive formats including tar, zip, gzip, bzip2, rar, etc. It simplifies the
extraction process by automatically detecting the file format and applying the
appropriate extraction method.
Detailed Explanation: ex.info
RAW Script: ex.sh
health_check.sh
Description: This script checks the availability of a given URL using both
HTTP and HTTPS protocols.
Detailed Explanation: health_check.info
RAW Script: health_check.sh
mkdirg.sh
Description: This script creates a directory if it doesn’t exist and
navigates into it.
Detailed Explanation: mkdirg.info
RAW Script: mkdirg.sh
mvg.sh
Description: This script moves a file or directory to a specified
destination and then enters the destination directory.
Detailed Explanation: mvg.info
RAW Script: mvg.sh
targzip.sh
Description: This script creates a tar archive of a directory or file and
compresses it using gzip.
Detailed Explanation: targzip.info
RAW Script: targzip.sh
tarzip.sh
Description: This script creates a compressed archive (.zip) of a specified
folder using tar and zip commands.
Detailed Explanation: tarzip.info
RAW Script: tarzip.sh
up.sh
Description: This script defines a function ‘up()’ to navigate up a
specified number of directory levels in the file system. To use it, execute the
script in a terminal and provide the number of levels to move up.
Detailed Explanation: up.info
RAW Script: up.sh
Dotfiles Scripts
Here’s a brief overview of scripts that are available in Homelab-Alpha Dotfiles repositorie:
dotfiles_installer.sh
Description: The script provides a function to install and uninstall
dotfiles, including creating backups and restoring them if necessary.
Detailed Explanation: dotfiles_installer.info
RAW Script: dotfiles_installer.sh
OpenSSL Scripts
Here’s a brief overview of scripts that are available in Homelab-Alpha OpenSSl repositorie:
openssl_installer.sh
Description: This script adds specified content to the ~/.bashrc file,
avoiding duplication. It checks if ~/.bashrc exists and appends the content to
the end if it doesn’t already exist..
Detailed Explanation: openssl_installer.info
RAW Script: openssl_installer.sh
openssl_setup.sh
Description: Sets up SSL certificate management directories, generates
random serial numbers, and creates OpenSSL configuration files.
Detailed Explanation: openssl_setup.info
RAW Script: openssl_setup.sh
trusted-id.sh
Description: This script generates and manages a trusted root certificate,
including key generation, certificate creation, verification, and format
conversion.
Detailed Explanation: trusted-id.info
RAW Script: trusted-id.sh
root_ca.sh
Description: This script sets up and manages a Root Certificate Authority,
handling key generation, CSR creation, certificate issuance, and verification
processes.
Detailed Explanation: root_ca.info
RAW Script: root_ca.sh
ca.sh
Description: This script manages an Intermediate Certificate Authority,
handling key generation, CSR creation, certificate issuance, and verification
processes.
Detailed Explanation: ca.info
RAW Script: ca.sh
cert_ecdsa_localhost.sh
Description: This script automates the generation of an ECDSA certificate
for localhost, handling key generation, CSR creation, certificate issuance, and
verification.
Detailed Explanation: cert_ecdsa_localhost.info
RAW Script: cert_ecdsa_localhost.sh
cert_ecdsa_server.sh
Description: This script automates the generation of an ECDSA server
certificate, handling key generation, CSR creation, certificate issuance, and
verification.
Detailed Explanation: cert_ecdsa_server.info
RAW Script: cert_ecdsa_server.sh
cert_ecdsa_client.sh
Description: This script automates the generation of an ECDSA client
certificate, including key creation, CSR generation, certificate issuance, and
verification.
Detailed Explanation: cert_ecdsa_client.info
RAW Script: cert_ecdsa_client.sh
cert_rsa_server.info
Description: This script automates the process of creating and managing RSA
certificates for server authentication, including key generation, CSR creation,
certificate issuance, verification, and preparation of certificate chain
bundles.
Detailed Explanation: cert_rsa_server.info
RAW Script: cert_rsa_server.sh
cert_rsa_client.sh
Description: Automates the process of creating and managing RSA client
certificates, including key generation, CSR creation, certificate issuance,
verification, and preparation of certificate chain bundles.
Detailed Explanation: cert_rsa_client.info
RAW Script: cert_rsa_client.sh
openssl_verify_certificates.sh
Description: This script verifies SSL/TLS certificates by checking them
against their corresponding chain of trust. It includes options for verbose
output for detailed verification processes.
Detailed Explanation: openssl_verify_certificates.info
RAW Script: openssl_verify_certificates.sh
Log Files
The location of log files can vary depending on the specific operating system
and application being used. Log files are often stored in a subdirectory within
the application’s installation directory or in a system directory such as
/var/log on Linux
Contribute to Homelab-Alpha - Shell Script
We value your contribution. We want to make it as easy as possible to submit
your contributions to the Homelab-Alpha - shell-script repository. Changes to
the shell-script are handled through pull requests against the main branch. To
learn how to contribute, see contribute.
Acknowledgements
- ShellCheck: A tool for analyzing shell scripts and providing suggestions for improvement.
- Bash Scripting Guide: A comprehensive guide to bash scripting.
Copyright and License
© 2024 Homelab-Alpha and its repositories are licensed under the terms of the license agreement.
Last updated 03 Nov 2024, 14:25 CET .