Tag v1.4.4

Resolves #5

Resolves #6

Author: Simewu

5G_Core_Network/full_install.sh

@@ -31,9 +31,10 @@
 # Exit immediately if a command fails
 set -e
 
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo apt-get install -y coreutils
+    sudo $APTVARS apt-get install -y coreutils
 fi
 
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
@@ -43,6 +44,53 @@ cd "$SCRIPT_DIR"
 if ! command -v yq &>/dev/null; then
     sudo "$SCRIPT_DIR/install_scripts/./install_yq.sh"
 fi
+# Check that the correct version of yq is installed
+if ! yq --version 2>/dev/null | grep -q 'https://github\.com/mikefarah/yq'; then
+    echo "ERROR: Detected an incompatible yq installation."
+    echo "Please ensure the Python yq is uninstalled with \"pip uninstall -y yq\", then re-run this script."
+    exit 1
+fi
+
+echo "Parsing options.yaml..."
+# Check if the YAML file exists, if not, set and save default values
+if [ ! -f "options.yaml" ]; then
+    echo "# Upon modification, apply changes with ./generate_configurations.sh." >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# Configure the MCC/MNC and TAC" >>"options.yaml"
+    echo "plmn: 00101" >>"options.yaml"
+    echo "tac: 7" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# Configure the DNN/APN" >>"options.yaml"
+    echo "dnn: nist-dnn" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# Configure the Single Network Slice Selection Assistance Information (S-NSSAI)" >>"options.yaml"
+    echo "sst: 1" >>"options.yaml"
+    echo "sd: FFFFFF" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# If false, AMF will use the default 127.0.0.5, true: it will use the hostname IP" >>"options.yaml"
+    echo "expose_amf_over_hostname: false" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# Toggle whether or not to include the Security Edge Protection Proxies (SEPP1 and SEPP2)" >>"options.yaml"
+    echo "include_sepp: false" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# Configure the ogstun gateway address for UE traffic" >>"options.yaml"
+    echo "ogstun_ipv4: 10.45.0.0/16" >>"options.yaml"
+    echo "ogstun_ipv6: 2001:db8:cafe::/48" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "ogstun2_ipv4: 10.46.0.0/16" >>"options.yaml"
+    echo "ogstun2_ipv6: 2001:db8:babe::/48" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "ogstun3_ipv4: 10.47.0.0/16" >>"options.yaml"
+    echo "ogstun3_ipv6: 2001:db8:face::/48" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# The use of systemctl can be disabled to support installations within Docker. Before changing this value, it is recommended to uninstall the testbed." >>"options.yaml"
+    echo "use_systemctl: true" >>"options.yaml"
+fi
+
+USE_SYSTEMCTL=$(yq eval '.use_systemctl' options.yaml)
+if [[ "$USE_SYSTEMCTL" == "null" || -z "$USE_SYSTEMCTL" ]]; then
+    USE_SYSTEMCTL="true" # Default
+fi
 
 # Check for open5gs-amfd and open5gs-upfd binaries to determine if Open5GS is already installed
 if [ -f "open5gs/install/bin/open5gs-amfd" ] && [ -f "open5gs/install/bin/open5gs-upfd" ]; then
@@ -59,39 +107,43 @@ INSTALL_START_TIME=$(date +%s)
 sudo rm -rf logs/
 
 # Prevent the unattended-upgrades service from creating dpkg locks that would error the script
-if systemctl is-active --quiet unattended-upgrades; then
-    sudo systemctl stop unattended-upgrades &>/dev/null && echo "Successfully stopped unattended-upgrades service."
-    sudo systemctl disable unattended-upgrades &>/dev/null && echo "Successfully disabled unattended-upgrades service."
-fi
-if systemctl is-active --quiet apt-daily.timer; then
-    sudo systemctl stop apt-daily.timer &>/dev/null && echo "Successfully stopped apt-daily.timer service."
-    sudo systemctl disable apt-daily.timer &>/dev/null && echo "Successfully disabled apt-daily.timer service."
-fi
-if systemctl is-active --quiet apt-daily-upgrade.timer; then
-    sudo systemctl stop apt-daily-upgrade.timer &>/dev/null && echo "Successfully stopped apt-daily-upgrade.timer service."
-    sudo systemctl disable apt-daily-upgrade.timer &>/dev/null && echo "Successfully disabled apt-daily-upgrade.timer service."
+if [[ "$USE_SYSTEMCTL" == "true" ]]; then
+    if systemctl is-active --quiet unattended-upgrades; then
+        sudo systemctl stop unattended-upgrades &>/dev/null && echo "Successfully stopped unattended-upgrades service."
+        sudo systemctl disable unattended-upgrades &>/dev/null && echo "Successfully disabled unattended-upgrades service."
+    fi
+    if systemctl is-active --quiet apt-daily.timer; then
+        sudo systemctl stop apt-daily.timer &>/dev/null && echo "Successfully stopped apt-daily.timer service."
+        sudo systemctl disable apt-daily.timer &>/dev/null && echo "Successfully disabled apt-daily.timer service."
+    fi
+    if systemctl is-active --quiet apt-daily-upgrade.timer; then
+        sudo systemctl stop apt-daily-upgrade.timer &>/dev/null && echo "Successfully stopped apt-daily-upgrade.timer service."
+        sudo systemctl disable apt-daily-upgrade.timer &>/dev/null && echo "Successfully disabled apt-daily-upgrade.timer service."
+    fi
 fi
 
 if [ ! -d "open5gs" ]; then
     echo "Cloning Open5GS..."
     ./install_scripts/git_clone.sh https://github.com/open5gs/open5gs.git
 fi
+
 cd $SCRIPT_DIR/open5gs
 
 echo
 echo
 echo "Installing Open5GS..."
-export DEBIAN_FRONTEND=noninteractive
 # Modifies the needrestart configuration to suppress interactive prompts
-if [ -f "/etc/needrestart/needrestart.conf" ]; then
-    if ! grep -q "^\$nrconf{restart} = 'a';$" "/etc/needrestart/needrestart.conf"; then
-        sudo sed -i "/\$nrconf{restart} = /c\$nrconf{restart} = 'a';" "/etc/needrestart/needrestart.conf"
-        echo "Modified needrestart configuration to auto-restart services."
-    fi
+if [ -d /etc/needrestart ]; then
+    sudo install -d -m 0755 /etc/needrestart/conf.d
+    sudo tee /etc/needrestart/conf.d/99-no-auto-restart.conf >/dev/null <<'EOF'
+# Disable automatic restarts during apt operations
+$nrconf{restart} = 'l';
+EOF
+    echo "Configured needrestart to list-only (no service restarts)."
 fi
-export NEEDRESTART_SUSPEND=1
 
 sudo "$SCRIPT_DIR/./install_scripts/install_mongodb.sh"
+sudo "$SCRIPT_DIR/./install_scripts/start_mongodb.sh"
 
 # Check and create the open5gs user and group if they don't exist
 if ! getent passwd open5gs >/dev/null; then
@@ -107,11 +159,11 @@ sudo usermod -a -G open5gs open5gs
 echo "Installing dependencies for building Open5GS..."
 
 # Code from (https://open5gs.org/open5gs/docs/guide/02-building-open5gs-from-sources#building-open5gs):
-sudo apt-get install -y python3-pip python3-setuptools python3-wheel ninja-build build-essential flex bison git cmake libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libmongoc-dev libbson-dev libyaml-dev libnghttp2-dev libmicrohttpd-dev libcurl4-gnutls-dev libnghttp2-dev libtins-dev libtalloc-dev meson
+sudo $APTVARS apt-get install -y python3-pip python3-setuptools python3-wheel ninja-build build-essential flex bison git cmake libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libmongoc-dev libbson-dev libyaml-dev libmicrohttpd-dev libcurl4-gnutls-dev libnghttp2-dev libtins-dev libtalloc-dev meson
 if apt-cache show libidn-dev >/dev/null 2>&1; then
-    sudo apt-get install -y --no-install-recommends libidn-dev
+    sudo $APTVARS apt-get install -y --no-install-recommends libidn-dev
 else
-    sudo apt-get install -y --no-install-recommends libidn11-dev
+    sudo $APTVARS apt-get install -y --no-install-recommends libidn11-dev
 fi
 
 rm -rf build

5G_Core_Network/full_uninstall.sh

@@ -33,9 +33,10 @@ set +e
 
 echo "# Script: $(realpath $0)..."
 
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo apt-get install -y coreutils
+    sudo $APTVARS apt-get install -y coreutils
 fi
 
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
@@ -59,6 +60,13 @@ echo "Removing Open5GS installation directory..."
 sudo rm -rf open5gs/
 sudo rm -rf /var/log/open5gs
 
+for INTERMEDIATE_DIR in open5gs-*; do
+    if [[ -d "$INTERMEDIATE_DIR" && "$INTERMEDIATE_DIR" != "open5gs-*" ]]; then
+        echo "Removing intermediate open5gs directory: $INTERMEDIATE_DIR"
+        sudo rm -rf "$INTERMEDIATE_DIR"
+    fi
+done
+
 echo "Uninstalling WebUI..."
 curl -fsSL https://open5gs.org/open5gs/assets/webui/uninstall | sudo -E bash -
 

5G_Core_Network/generate_configurations.sh

@@ -33,9 +33,10 @@ set -e
 
 UE_NUMBERS=(3 2 1) # Subscribers from UE 3 to UE 1
 
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo apt-get install -y coreutils
+    sudo $APTVARS apt-get install -y coreutils
 fi
 
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
@@ -45,6 +46,12 @@ cd "$SCRIPT_DIR"
 if ! command -v yq &>/dev/null; then
     sudo "$SCRIPT_DIR/install_scripts/./install_yq.sh"
 fi
+# Check that the correct version of yq is installed
+if ! yq --version 2>/dev/null | grep -q 'https://github\.com/mikefarah/yq'; then
+    echo "ERROR: Detected an incompatible yq installation."
+    echo "Please ensure the Python yq is uninstalled with \"pip uninstall -y yq\", then re-run this script."
+    exit 1
+fi
 
 echo "Parsing options.yaml..."
 # Check if the YAML file exists, if not, set and save default values
@@ -77,6 +84,9 @@ if [ ! -f "options.yaml" ]; then
     echo "" >>"options.yaml"
     echo "ogstun3_ipv4: 10.47.0.0/16" >>"options.yaml"
     echo "ogstun3_ipv6: 2001:db8:face::/48" >>"options.yaml"
+    echo "" >>"options.yaml"
+    echo "# The use of systemctl can be disabled to support installations within Docker. Before changing this value, it is recommended to uninstall the testbed." >>"options.yaml"
+    echo "use_systemctl: true" >>"options.yaml"
 fi
 
 # If expose_amf_over_hostname is false, AMF will use the default 127.0.0.5, otherwise, it will use the hostname IP
@@ -128,6 +138,12 @@ echo "Creating configs directory..."
 rm -rf configs
 mkdir configs
 
+MONGODB_CONFIG_FILE="/etc/mongod/mongod.conf"
+if [ -f "$MONGODB_CONFIG_FILE" ]; then
+    echo "Creating symbolic link for MongoDB configuration file..."
+    sudo ln -s "$MONGODB_CONFIG_FILE" configs/mongod.conf
+fi
+
 # Only remove the logs if no component is running
 RUNNING_STATUS=$(./is_running.sh)
 if [[ $RUNNING_STATUS != *": RUNNING"* ]]; then

5G_Core_Network/install_scripts/git_clone.sh

@@ -50,9 +50,10 @@ if [[ -z "$NAME" ]]; then
     NAME=$(basename "$URL" .git)
 fi
 
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo apt-get install -y coreutils
+    sudo $APTVARS apt-get install -y coreutils
 fi
 
 CURRENT_DIR=$(pwd)
@@ -62,7 +63,7 @@ HOME_DIR=$(dirname "$(dirname "$SCRIPT_DIR")")
 
 if ! command -v jq &>/dev/null; then
     echo "Installing jq..."
-    sudo apt-get install -y jq
+    sudo $APTVARS apt-get install -y jq
 fi
 
 # First check the directory containing install_scripts/, otherwise, use the home directory

5G_Core_Network/install_scripts/install_mongodb.sh

@@ -31,7 +31,10 @@
 echo "# Script: $(realpath $0)..."
 
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
-cd "$(dirname "$SCRIPT_DIR")"
+PARENT_DIR=$(dirname "$SCRIPT_DIR")
+cd "$PARENT_DIR"
+
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 
 UBUNTU_CODENAME=$(./install_scripts/get_ubuntu_codename.sh)
 INSTALLED_VERSION=$(mongod --version 2>/dev/null | grep -oP "(?<=v)\d+\.\d+\.\d+") || true
@@ -96,7 +99,7 @@ else
     fi
 
     echo "Installing gnupg and curl if not already installed..."
-    sudo apt-get install -y gnupg curl || {
+    sudo $APTVARS apt-get install -y gnupg curl || {
         echo "Failed to install GnuPG or curl"
         exit 1
     }
@@ -125,21 +128,21 @@ else
     fi
 
     echo "Attempting to install MongoDB 4.4..."
-    if ! sudo apt-get install -y --allow-change-held-packages mongodb-org=4.4.* mongodb-org-server=4.4.* mongodb-org-shell=4.4.* mongodb-org-mongos=4.4.* mongodb-org-tools=4.4.*; then
+    if ! sudo $APTVARS apt-get install -y --allow-change-held-packages mongodb-org=4.4.* mongodb-org-server=4.4.* mongodb-org-shell=4.4.* mongodb-org-mongos=4.4.* mongodb-org-tools=4.4.*; then
         echo "Initial MongoDB installation failed. Attempting to fix broken installations..."
         sudo apt-get --fix-broken install
         sudo apt-get autoremove -y
         sudo apt-get clean
         echo "Trying to install MongoDB 4.4 again..."
-        if ! sudo apt-get install -y --allow-change-held-packages mongodb-org=4.4.* mongodb-org-server=4.4.* mongodb-org-shell=4.4.* mongodb-org-mongos=4.4.* mongodb-org-tools=4.4.*; then
+        if ! sudo $APTVARS apt-get install -y --allow-change-held-packages mongodb-org=4.4.* mongodb-org-server=4.4.* mongodb-org-shell=4.4.* mongodb-org-mongos=4.4.* mongodb-org-tools=4.4.*; then
             echo "Failed to install MongoDB 4.4 after attempting repairs. Exiting script."
             exit 1
         fi
     fi
 fi
 
 echo "Attempting to install mongosh..."
-if ! sudo apt-get install -y --allow-change-held-packages mongosh; then
+if ! sudo $APTVARS apt-get install -y --allow-change-held-packages mongosh; then
     echo "Failed initial attempt to install mongosh. Adding MongoDB 5.0 repository for mongosh..."
     # Import the MongoDB 5.0 public key
     if ! curl -fsSL https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -; then
@@ -156,13 +159,13 @@ if ! sudo apt-get install -y --allow-change-held-packages mongosh; then
     done
 
     sudo apt-get update
-    if ! sudo apt-get install -y --allow-change-held-packages mongodb-mongosh; then
+    if ! sudo $APTVARS apt-get install -y --allow-change-held-packages mongodb-mongosh; then
         echo "Failed to install mongosh even from MongoDB 5.0 repository. Attempting to fix broken installations..."
         sudo apt-get --fix-broken install
         sudo apt-get autoremove -y
         sudo apt-get clean
         echo "Trying to install mongosh again..."
-        if ! sudo apt-get install -y --allow-change-held-packages mongodb-mongosh; then
+        if ! sudo $APTVARS apt-get install -y --allow-change-held-packages mongodb-mongosh; then
             echo "An error occured. Running dpkg --configure -a to ensure all packages are properly configured..."
             sudo dpkg --configure -a || true
             echo "Failed to install mongosh after attempting repairs. Exiting script."
@@ -225,21 +228,5 @@ fi
 sudo mkdir -p /var/lib/mongodb /var/log/mongodb
 sudo chown -R mongodb:mongodb /var/lib/mongodb /var/log/mongodb
 
-# Point mongodb to the correct configuration file
-sudo sed -i "s|ExecStart=/usr/bin/mongod --config .*|ExecStart=/usr/bin/mongod --config $CONFIG_FILE|" /lib/systemd/system/mongod.service
-sudo systemctl daemon-reload
-
-echo "Checking MongoDB service..."
-if ! sudo systemctl is-active --quiet mongod; then
-    echo "Starting MongoDB service..."
-    sudo systemctl start mongod
-else
-    echo "MongoDB service is already running."
-fi
-
-if ! sudo systemctl is-enabled --quiet mongod; then
-    echo "Enabling MongoDB service to start on boot..."
-    sudo systemctl enable mongod
-else
-    echo "MongoDB service is already enabled to start on boot."
-fi
+echo "Enabling MongoDB service..."
+sudo ./install_scripts/start_mongodb.sh

5G_Core_Network/install_scripts/install_webui.sh

@@ -30,7 +30,14 @@
 
 echo "# Script: $(realpath $0)..."
 
-sudo apt-get install -y ca-certificates curl gnupg
+SCRIPT_DIR=$(dirname "$(realpath "$0")")
+PARENT_DIR=$(dirname "$SCRIPT_DIR")
+cd "$PARENT_DIR"
+
+sudo ./install_scripts/start_mongodb.sh
+
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
+sudo $APTVARS apt-get install -y ca-certificates curl gnupg
 sudo mkdir -p /etc/apt/keyrings
 curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor --yes -o /etc/apt/keyrings/nodesource.gpg
 
@@ -47,6 +54,6 @@ fi
 
 sudo apt-get update
 
-sudo apt-get install -y nodejs
+sudo $APTVARS apt-get install -y nodejs
 
 curl -fsSL https://open5gs.org/open5gs/assets/webui/install | sudo -E bash -

5G_Core_Network/install_scripts/install_yq.sh

@@ -30,7 +30,7 @@
 
 echo "# Script: $(realpath $0)..."
 
-# Uninstall yq with: sudo rm -rf /usr/bin/yq
+# Uninstall yq with: sudo rm -rf /usr/local/bin/yq; hash -r && hash -r
 if command -v yq &>/dev/null; then
     echo "Already installed yq, skipping."
     exit 0

5G_Core_Network/install_scripts/register_subscriber.sh

@@ -28,9 +28,10 @@
 # damage to property. The software developed by NIST employees is not subject to
 # copyright protection within the United States.
 
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo apt-get install -y coreutils
+    sudo $APTVARS apt-get install -y coreutils
 fi
 
 echo "# Script: $(realpath $0)..."
@@ -49,10 +50,7 @@ DEFAULT_APN="internet"
 DEFAULT_SST=""
 DEFAULT_SD=""
 
-if ! systemctl is-active --quiet "open5gs-webui"; then
-    echo "WebUI not running. Starting..."
-    sudo systemctl start open5gs-webui
-fi
+./start_webui.sh no-browser
 
 # Function to display usage
 usage() {