Eos

Eos aims to help make ubuntu server administration easier for those of us who weren't born in a bash shell.

We use all the tools here on a daily basis. Because of this, you can be assured they are actively used and maintained. You should also be aware, therefore, that because they are being actively updated and adjusted, they should be considered 'current best effort' and not a perfect product.

Run getStarted.sh

This is done typing:

user@hostname:~$ cd ~/Eos
user@hostname:~$ sudo ./getStarted.sh

While not 100% necessary, this adds some helpful open source shell utilities and the necessary packages needed to run the scripts in Eos without further bother. So, not strictly necessary, but highly recommended.

For example

Turns:

sudo useradd -m -s /bin/bash user
echo "user:supersecretpassword" | sudo chpasswd
sudo usermod -aG sudo user

Into something a human can understand:

sudo ./addUser.sh

The terminal will then ask you to:

Enter the new username:
Enter the password:
Confirm password:
Should this user have sudo privileges?:

How to use scripts ending in .sh

These scripts are bash shell scripts In the 'For Example' section above, we added a new user. The script to add a new user is called 'addUser.sh', so:

Start in the main scripts directory

user@hostname:~$ cd ~/Eos/scripts

Make sure the script you want to run is executable:

user@hostname:~/Eos/scripts$ sudo chmod +x addUser.sh

Then execute it:

user@hostname:~/Eos/scripts$ sudo ./addUser.sh

The script to create a new SSH key is called 'createSshKey.sh'. So, to create a new SSH key, we simply:

user@hostname:~/Eos/scripts$ sudo ./createSshKey.sh

How to use scripts ending in .py

These scripts are written in python. Python is almost always installed by default in Ubuntu distributions. If the script ends in .py, for example configureBorg.py, type:

user@hostname:~$ cd ~/Eos/scripts
user@hostname:~/Eos/scripts$ sudo python3 configureBorg.py

and press enter

How to use scripts ending in .mjs

These scripts are written in a javascript-based scripting language which is maintained by Google, zx. These zx scripts end in .mjs, for example 'installKube.mjs'. The 'installKube.mjs' script helps install a Kubernetes cluster. If the script ends in .mjs, for example 'installKube.mjs':

Install zx globally using node package manager (npm)

user@hostname:~$ cd ~/Eos/scripts
user@hostname:~/Eos/scripts$ sudo apt install npm #If npm isn't already installed, or you don't know whether it is installed or not
user@hostname:~/Eos/scripts$ sudo npm install -g zx

Make sure the script you want to run is executable. For this example we are using 'installKube.mjs', so:

user@hostname:~/Eos/scripts$ sudo chmod +x installKube.mjs

To run the script:

user@hostname:~/Eos/scripts$ sudo zx installKube.mjs

Replace 'installKube.mjs' with whichever .mjs script you want to run.

NOTE: .mjs is slowly going to be phased out in this repo in favour of using python3 whenever possible and bash.sh scripts where python3 is too cumbersome. This is for the sake of simplicity and uniformity.

What directories and files will be used

CONFIG_FILE = '/etc/CodeMonkeyCyber/Eos/borgConfig.yaml'

LOG_DIR = '/var/log/CodeMonkeyCyber'

LOG_FILE = f'{LOG_DIR}/Eos.log'

SUBMODULES_SOURCE = './submodules'

SUBMODULES_DEST = '/usr/local/bin/Eos'

What other scripts are available?

To find out what other scripts are available:

user@hostname:~/Eos/scripts$ ls

How to script

#!/bin/bash
# ^ this makes it a bash script

# This is a comment, the computer ignores these

# to get the computer to say something
echo "Hello, World!"

# to assign a variable
# Variables: Assign values without spaces around = and reference variables using $.
name="Henry"
echo "Hello, $name!"

# Quoting:
#	Double quotes ("): Preserve variable substitution.
#	Single quotes ('): Preserve literal value.
#	Backticks or $(): Command substitution.
echo "Your current working directory is: $(pwd)"

# Conditionals: if, else, elif.
if [ "$name" == "Henry" ]; then
    echo "Welcome, Henry!"
else
    echo "User not recognized."
fi

# for loop:
for i in {1..5}; do
  echo "Number $i"
done

# while loop:
count=1
while [ $count -le 5 ]; do
  echo "Count: $count"
  ((count++))
done

# Functions
# Define reusable code blocks using functions:
my_function() {
    echo "Hello from a function!"
}

my_function  # Call the function


# Input and Output 
# Reading User Input:
read -p "Enter your name: " name
echo "Hello, $name!"

# Redirecting output
echo "Logging info" > log.txt   # Overwrites the file
echo "More info" >> log.txt    # Appends to the file

# Standard error 
command 2> error.log

# Combine stdout (standard output) and stderr (standard error) (&>):
command &> output.log

#  Exit Status: Every command returns an exit status (0 for success, non-zero for error). Check with $?.
mkdir /some/dir
if [ $? -ne 0 ]; then
    echo "Failed to create directory."
fi

# set Commands:
#	•	set -e: Exit immediately if a command exits with a non-zero status.
#	•	set -u: Treat unset variables as an error.
#	•	set -x: Print each command before executing it (useful for debugging).

# Iterate Over Files:
for file in /path/to/directory/*; do
    echo "Processing $file"
done

# Using Command-Line Arguments
# Access arguments using $1, $2, etc. $@ refers to all arguments, and $# gives the count.
echo "First argument: $1"
echo "All arguments: $@"

# Commonly Used Commands in Scripts
#	•	grep: Search for patterns.
#	•	sed: Stream editor for modifying files.
#	•	awk: Text processing.
#	•	find: Search for files.
#	•	xargs: Build and execute command lines from input.
#	•	cron: Schedule jobs.

Complaints, compliments, confusion and other communications:

Secure email: [email protected]

Website: cybermonkey.net.au

     ___         _       __  __          _
    / __|___  __| |___  |  \/  |___ _ _ | |_____ _  _
   | (__/ _ \/ _` / -_) | |\/| / _ \ ' \| / / -_) || |
    \___\___/\__,_\___| |_|  |_\___/_||_|_\_\___|\_, |
                  / __|  _| |__  ___ _ _         |__/
                 | (_| || | '_ \/ -_) '_|
                  \___\_, |_.__/\___|_|
                      |__/