Scripts Collection

A collection of useful scripts for various Linux distributions

Scripts

Category / Script	Supports
Asset Tracking / Collect Asset Inventory (Grist) [Linux]
Asset Tracking / Collect Asset Inventory (Grist) [Windows]
Asset Tracking / Collect Asset Inventory (SuiteCRM) [Linux]
Asset Tracking / Collect Asset Inventory (SuiteCRM) [Windows]
Backup / Backup Nextcloud Server [Linux]
Disks / Check Disk Health [Linux]
Disks / Check Disk Health [Windows]
Disks / Check Disk Space [Linux]
Disks / Check Disk Space [Windows]
Firewall / Check Firewall Status [Linux]
Firewall / Check Firewall Status [Windows]
Firewall / Firewall - Allow IP/Port [Linux]
Firewall / Firewall - Whitelist IP
Licensing / Get Windows License Information
Memory / Check Memory Usage [Linux]
Memory / Check Memory Usage [Windows]
Monitoring / Install Graylog Sidecar [Linux]
Monitoring / Install Zabbix Agent2 [Linux]
Monitoring / Install Zabbix Proxy [Linux]
Network Utility / Install net-diag utilities [Linux]
Networking / Set Hostname and Restart [Windows]
Repo / Switch Repo to Community [Proxmox]
Security / Check Defender Status [Windows]
Security / Install Firewall (UFW) [Linux]
Security / Virtualmin Renew All SSL [Linux]
System Cleanup / Remove Bloatware in Win10 [Windows]
System / Install 7zip [Linux]
System / Install rar [Linux]
System / Install unrar [Linux]
System / Install unzip [Linux]
System / Install zip [Linux]
Updates / Check if Reboot Required [Linux]
Updates / Check if Reboot Required [Windows]
User Management / Authorize SSH Key [Linux]
User Management / Get SSH Public Key [Linux]

Install as Python Package

This project can be installed as a Python package directly from GitHub, providing access to some Python libraries.

Installation

pip install git+https://github.com/eVAL-Agency/ScriptsCollection.git

For development/editable installation:

git clone https://github.com/eVAL-Agency/ScriptsCollection.git
cd ScriptsCollection
pip install -e .

Compile all scripts

Will compile each script into a single distributable file with all dependencies included within.

python3 compile.py

Script Metadata

Most of the metadata is collected from the file header. To ensure rendering, please ensure all file headers start with # , and separating lines contain a #.

Header scanning will stop as soon as an empty line is encountered.

Example, this will not see the "Supports" section as a header field, and thus will not include it.

#!/bin/bash
#
# Some title

# Supports:
#    Debian 12

Correct form includes a '#' to ensure the entire block is seen as the file header.

#!/bin/bash
#
# Some title
#
# Supports:
#    Debian 12

Script Header

The first non-empty line retrieved from the script will be used as the title, (one line only).

Syntax

Lists how to run the application to the end user, and gets saved in the help icon in TRMM.

#/bin/bash
# ...
# Syntax:
#   --option1 - Short description of option 1
#   --option2=... - Short description of option 2

#!/usr/bin/env python3
"""
...
Syntax:
	--option1 - Short description of option 1
	--option2=... - Short description of option 2
"""

Argument Parsing

Adding # compile:argparse to the script will generate a dynamic argument parser for the script.

(BASH only) Optionally, you can include the destination variable name before each argument to allow for dynamic generation of the argument parsing via compile:argparse.

In this example, passing --noninteractive will set the variable NONINTERACTIVE to 1.

(The compiler will filter out the prefix)

#/bin/bash
# ...
# Syntax:
#   NONINTERACTIVE=--noninteractive - Run in non-interactive mode, (will not ask for prompts)
#   VERSION=--version=... - Version of Zabbix to install DEFAULT=7.0
#   ZABBIX_SERVER=--server=... - Hostname or IP of Zabbix server
#   ZABBIX_AGENT_HOSTNAME=--hostname=... - Hostname of local device for matching with a Zabbix host entry
# ...

# compile:argparse

Generates:

#/bin/bash
# ...
# Syntax:
#   --noninteractive - Run in non-interactive mode, (will not ask for prompts)
#   --version=... - Version of Zabbix to install DEFAULT=7.0
#   --server=... - Hostname or IP of Zabbix server
#   --hostname=... - Hostname of local device for matching with a Zabbix host entry
# ...

# Parse arguments
NONINTERACTIVE="0"
VERSION="7.0"
ZABBIX_SERVER=""
ZABBIX_AGENT_HOSTNAME=""
while [ "$#" -gt 0 ]; do
	case "$1" in
		--noninteractive) NONINTERACTIVE=1; shift 1;;
		--version=*) VERSION="${1#*=}"; shift 1;;
		--server=*) ZABBIX_SERVER="${1#*=}"; shift 1;;
		--hostname=*) ZABBIX_AGENT_HOSTNAME="${1#*=}"; shift 1;;
		-h|--help) usage;;
	esac
done
if [ -z "$SOURCE" ]; then
	usage
fi

#!/usr/bin/env python3
"""
Do something

Syntax:
	--arg1=<str> - Some parameter DEFAULT=yup
	--arg2=<int> - The SSH key to authorize DEFAULT=42
"""

import argparse

# ...

parser = argparse.ArgumentParser(
	prog='scriptname.py',
	description='Does a thing')
# compile:argparse
args = parser.parse_args()

Variable Type

To support Python, ensure a variable type is specified, like so:

#!/usr/bin/env python3
"""
Syntax:
	--option1=<str> - Short description of option 1
	--option2=<int> - Short description of option 2
"""

Argument types in Bash are ignored and are for reference only.

Defaults

The default value can be specified by appending DEFAULT=(value) to the argument, like so:

#/bin/bash
# ...
# Syntax:
#   --option1=<str> - Short description of option 1 DEFAULT=default_value
#   --option2=<int> - Short description of option 2 DEFAULT=42

TRMM Arguments

Lists the default arguments and their values to be used when running the script in TRMM.

DOES support TRMM variable replacement for site, client, and agent. To use these, wrap the variable in double curly braces, like so: {{client.zabbix_hostname}}

#/bin/bash
# ...
# TRMM Arguments:
#   --option1
#   --option2=something

#!/usr/bin/env python3
"""
...
Syntax:
	--option1 - Short description of option 1
	--option2=... - Short description of option 2
"""

TRMM Environment

Behaves the same as TRMM Arguments, but is used for environment variables.

#/bin/bash
# ...
# TRMM Environment:
#   VAR1=something
#   VAR2={{client.zabbix_hostname}}

#!/usr/bin/env python3
"""
...
TRMM Environment:
	VAR1=something
	VAR2={{client.zabbix_hostname}}
"""

Supports

Lists the OS support for the script.

#/bin/bash
# ...
# Supports:
#   Debian 12
#   Ubuntu 24.04

#!/usr/bin/env python3
"""
...
Supports:
	Debian 12
	Ubuntu 24.04
"""

Distros can be listed individually, or one of the group declarations for multiple distros.

Linux-All - All Linux-based distros (completely os-agnostic script)
Debian-All - Any Debian-based distro (Debian, Ubuntu, Mint, etc)
RHEL-All - Any Red Hat-based distro (RHEL, CentOS, Fedora, etc)
ArchLinux / arch
CentOS
Debian
Fedora
LinuxMint
RedHat / RHEL
Rocky / RockyLinux
SuSE / OpenSuSE
Ubuntu
Windows

Author Tag

#/bin/bash
# ...
# Author:
#   Some Name <some-email@domain.tld>

alternative syntax:

#/bin/bash
# ...
# @AUTHOR  Some Name <some-email@domain.tld>

#!/usr/bin/env python3
"""
...
@AUTHOR  Some Name <some-email@domain.tld>
"""

Category Tag

#/bin/bash
# ...
# Category:
#   Some Category

alternative syntax:

#/bin/bash
# ...
# @CATEGORY  Some Category

#!/usr/bin/env python3
"""
...
Category:
	Some Category
"""

TRMM Timeout Setting

#/bin/bash
# ...
# @TRMM-TIMEOUT  120

#!/usr/bin/env python3
"""
...
@TRMM-TIMEOUT  120
"""

Draft

Set to true to skip finalizing of the script. The script will still be generated to dist/, but will not be recorded in the README and TRMM metafile.

#/bin/bash
# ...
# Draft:
#   True

#!/usr/bin/env python3
"""
...
Draft:
	True
"""

Generative Code

The compiler can generate dynamic code based on script comments, notably for usage and arguments

Compile usage()

Will generate a "usage()" function with the description and syntax arguments.

# compile:usage

Scriptlets

Scriptlets are small pieces of reusable code that can be included in scripts during compilation. This system provides a number of scripts, and more can be added by adding a compile.sources file in the root of the project with the format:

scriptlet_type=github:repo_owner/repo_name

Where scriptlet_type is the directory that contains the scriptlets to include.

By default main is used to download sources, but a different branch can be specified by appending :branch_name.

ufw/install.sh

To include this scriptlet:

# scriptlet:ufw/install.sh

function install_ufw:

Install UFW

io_github_lsferreira42/lib_ini.sh

To include this scriptlet:

# scriptlet:io_github_lsferreira42/lib_ini.sh

function ini_debug:

Print debug messages

function ini_error:

Print error messages

function ini_validate_section_name:

Validate section name

function ini_validate_key_name:

Validate key name

function ini_create_temp_file:

Create a secure temporary file

function ini_trim:

Trim whitespace from start and end of a string

function ini_escape_for_regex:

Escape special characters in a string for regex matching

function ini_check_file:

function ini_read:

function ini_list_sections:

function ini_list_keys:

function ini_section_exists:

function ini_add_section:

function ini_write:

function ini_remove_section:

function ini_remove_key:

function ini_get_or_default:

function ini_import:

function ini_to_env:

function ini_key_exists:

function ini_read_array:

function ini_write_array:

openjdk/install.sh

To include this scriptlet:

# scriptlet:openjdk/install.sh

function install_openjdk:

Install OpenJDK from Eclipse Adoptium

https://github.com/adoptium

@arg $1 string OpenJDK version to install

Will print the directory where OpenJDK was installed.

CHANGELOG: 2026.01.13 - Initial version

steam/install-steamcmd.sh

To include this scriptlet:

# scriptlet:steam/install-steamcmd.sh

function install_steamcmd:

Install SteamCMD

CHANGELOG:

2025.12.16 - Ensure steam GPG key is readable by apt 2025.11.09 - Switch to using download to support curl/wget abstraction 2025.11.03 - Add support for Debian 13 2024.12.23 - Add support for non-interactive acceptance of Steam license 2024.12.22 - Initial version

firewalld/install.sh

To include this scriptlet:

# scriptlet:firewalld/install.sh

function install_firewalld:

Install firewalld

bz_eval_tui/print_header.sh

To include this scriptlet:

# scriptlet:bz_eval_tui/print_header.sh

function print_header:

Print a header message

CHANGELOG: 2025.11.09 - Port from _common to bz_eval_tui 2024.12.25 - Initial version

bz_eval_tui/prompt_text.sh

To include this scriptlet:

# scriptlet:bz_eval_tui/prompt_text.sh

function prompt_text:

Prompt user for a text response

Arguments: --default="..." Default text to use if no response is given

Returns: text as entered by user

CHANGELOG: 2025.11.23 - Use is_noninteractive to handle non-interactive mode 2025.01.01 - Initial version

bz_eval_tui/prompt_yn.sh

To include this scriptlet:

# scriptlet:bz_eval_tui/prompt_yn.sh

function prompt_yn:

Prompt user for a yes or no response

Arguments: --invert Invert the response (yes becomes 0, no becomes 1) --default-yes Default to yes if no response is given --default-no Default to no if no response is given -q Quiet mode (no output text after response)

Returns: 1 for yes, 0 for no (or inverted if --invert is set)

CHANGELOG: 2025.12.16 - Add text output for non-interactive and empty responses 2025.11.23 - Use is_noninteractive to handle non-interactive mode 2025.11.09 - Add -q (quiet) option to suppress output after prompt (and use return value) 2025.01.01 - Initial version

zabbix/repo-setup.sh

To include this scriptlet:

# scriptlet:zabbix/repo-setup.sh

function zabbix_repo_setup:

Setup the Zabbix repo for this OS, shared between agent, agent2, server, and proxy.

xvfb/install.sh

To include this scriptlet:

# scriptlet:xvfb/install.sh

function install_xvfb:

Install Xvfb and (optionally) a daemon helper

Syntax: install_xvfb [--no-daemon] [--display ] [--service ]

Changelog: 20260216 - Initial version

_common/package_remove.sh

To include this scriptlet:

# scriptlet:_common/package_remove.sh

function package_remove:

Remove a package with the system's package manager.

Uses Redhat's yum, Debian's apt-get, and SuSE's zypper.

Usage:

package_remove apache2

@param $1..$N string Package, (or packages), to remove. Accepts multiple packages at once.

_common/setconfigfile_orappend.sh

To include this scriptlet:

# scriptlet:_common/setconfigfile_orappend.sh

function setconfigfile_orappend:

Use sed to set a line in a config file

If the target line does not exist, it will simply get appended to the end

Arguments: $1 Line match $2 Line replace $3 filename

Example: setconfigfile_orappend "^Password=.*" "Password=1234" "/etc/myapp/myapp.conf"

CHANGELOG: 2025.04.10 - Escape '?' characters in the sed search

_common/random_password.sh

To include this scriptlet:

# scriptlet:_common/random_password.sh

function random_password:

Generate a random password, (using characters that are easy to read and type)

_common/print_header.sh

To include this scriptlet:

# scriptlet:_common/print_header.sh

_common/require_root.sh

To include this scriptlet:

# scriptlet:_common/require_root.sh

_common/get_wan_ip.sh

To include this scriptlet:

# scriptlet:_common/get_wan_ip.sh

function get_wan_ip:

Try to retrieve the WAN IP of this device based on ipify.org

CHANGELOG: 2025.12.15 - Use cmd_exists to fix regression bug 2025.11.23 - use which -s for cleaner checks 2025.11.09 - Initial version

_common/get_firewall.sh

To include this scriptlet:

# scriptlet:_common/get_firewall.sh

function get_enabled_firewall:

Get which firewall is enabled, or "none" if none located

function get_available_firewall:

Get which firewall is available on the local system, or "none" if none located

CHANGELOG: 2025.12.15 - Use cmd_exists to fix regression bug 2025.04.10 - Switch from "systemctl list-unit-files" to "which" to support older systems

_common/prompt_text.sh

To include this scriptlet:

# scriptlet:_common/prompt_text.sh

function prompt_text:

Prompt user for a text response

Arguments: --default="..." Default text to use if no response is given

Returns: text as entered by user

_common/cmd_exists.sh

To include this scriptlet:

# scriptlet:_common/cmd_exists.sh

function cmd_exists:

Simple wrapper to emulate which -s

The -s flag is not available on all systems, so this function provides a consistent way to check for command existence without having to include '&>/dev/null' everywhere.

Returns 0 on success, 1 on failure

Arguments: $1 - Command to check

CHANGELOG: 2025.12.15 - Initial version (for a regression fix)

_common/firewall_allow.sh

To include this scriptlet:

# scriptlet:_common/firewall_allow.sh

function firewall_allow:

scriptlet:_common/get_firewall.sh

Add an "allow" rule to the firewall in the INPUT chain

Arguments: --port Port(s) to allow --source Source IP to allow (default: any) --zone Zone to allow (default: public) --tcp|--udp Protocol to allow (default: tcp) --proto <tcp|udp> Protocol to allow (alternative method) --comment (only UFW) Comment for the rule

Specify multiple ports with --port '#,#,#' or a range --port '#:#'

CHANGELOG: 2025.11.23 - Use return codes instead of exit to allow the caller to handle errors 2025.04.10 - Add "--proto" argument as alternative to "--tcp|--udp"

_common/download.sh

To include this scriptlet:

# scriptlet:_common/download.sh

function download:

Simple download utility function

Uses either cURL or wget based on which is available

Downloads the file to a temp location initially, then moves it to the final destination upon a successful download to avoid partial files.

Returns 0 on success, 1 on failure

Arguments: --no-overwrite Skip download if destination file already exists

CHANGELOG: 2025.12.15 - Use cmd_exists to fix regression bug 2025.12.04 - Add --no-overwrite option to allow skipping download if the destination file exists 2025.11.23 - Download to a temp location to verify download was successful

use which -s for cleaner checks 2025.11.09 - Initial version

_common/os_version.sh

To include this scriptlet:

# scriptlet:_common/os_version.sh

function os_version:

Get the operating system version

Just the major version number is returned

_common/is_noninteractive.sh

To include this scriptlet:

# scriptlet:_common/is_noninteractive.sh

function is_noninteractive:

Determine if the current shell session is non-interactive.

Checks NONINTERACTIVE, CI, DEBIAN_FRONTEND, and TERM.

Returns 0 (true) if non-interactive, 1 (false) if interactive.

CHANGELOG: 2025.12.16 - Remove TTY checks to avoid false positives in some environments 2025.11.23 - Initial version

_common/os.sh

To include this scriptlet:

# scriptlet:_common/os.sh

function os:

Get the operating system

almalinux, alpine, amzn, antergos, arch, archarm, arcolinux, centos, clear-linux-os, clearos, debian, elementary, endeavouros, fedora, freebsd, gentoo, kali, linuxmint, mageia, manjaro, nixos, opensuse, ol, pop, raspbian, rhel, rocky, scientific, slackware, sles, ubuntu, virtuozzo