Guide: Virtualbox 6.x and PHPVirtualbox on OMV5 and Debian 10.x

server {
server_name phpvirtualbox-webgui;
root /var/www/phpvirtualbox;
index index.html;
autoindex off;
server_tokens off;
sendfile on;
large_client_header_buffers 4 32k;
client_max_body_size 25M;
error_log /var/log/nginx/phpvirtualbox-webgui_error.log error;
access_log /var/log/nginx/phpvirtualbox-webgui_access.log combined;
error_page 404 = /404.php;
location /404.html {
internal;
}
location /extjs6/ {
alias /usr/share/javascript/extjs6/;
expires 2d;
}
location ~ ^/(css|js|images)/ {
expires 2d;
}
location /favicon {
expires 14d;
}
location ~ \.php$ {
try_files $uri =404;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/run/php/php7.3-fpm-phpvirtualbox-webgui.sock;
fastcgi_index index.php;
fastcgi_read_timeout 60s;
include fastcgi.conf;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
}
listen [::]:8080 ipv6only=off;
include /etc/nginx/phpvirtualbox-webgui.d/*.conf;
}

[phpvirtualbox-webgui]
user = phpvirtualbox-webgui
group = phpvirtualbox-webgui
listen = /run/php/php7.3-fpm-phpvirtualbox-webgui.sock
listen.owner = www-data
listen.group = www-data
listen.mode = 0600
pm = ondemand
pm.max_children = 25
pm.process_idle_timeout = 10s
chdir = /
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; phpvirtualbox php.ini settings ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Paths and Directories
php_value[include_path] = ".:/usr/share/php:/var/www/phpvirtualbox"
; Pam Authentication Support (see /etc/pam.d)
php_value[pam.servicename] = "phpvirtualbox-webgui";
; Maximum allowed size for uploaded files.
; http://php.net/upload-max-filesize
php_value[upload_max_filesize] = 25M
; Maximum size of POST data that PHP will accept.
; http://php.net/post-max-size
php_value[post_max_size] = 25M
; Do not expose to the world that PHP is installed on the server.
; http://php.net/expose-php
php_value[expose_php] = Off
; Name of the session (used as cookie name).
; http://php.net/session.name
php_value[session.name] = X-PHPVIRTUALBOX-SESSIONID
; Default timeout for socket based streams (seconds)
; http://php.net/default-socket-timeout
php_value[default_socket_timeout] = 90
; Maximum execution time of each script, in seconds
; http://php.net/max-execution-time
; Note: This directive is hardcoded to 0 for the CLI SAPI
php_value[max_execution_time] = 90

#!/bin/bash
# Loop through all VirtualBox VMs, pause, export,
# and restore them to their original states.
#
# Vorkbaard, 2012-02-01, 2018-02-09
# RoRu69 2020-03-04 - More logging and reboot after export for recovering mapped USB ports after saving state.
# =============== Set your variables here ===============
EXPORTDIR=[Path to Export directory]
LOGFILE=[Path to Export directory]/logs/"vmbackup-$(date +%Y%m%d_%H%M%S)".log
declare -a REBOOT=("[Server you want to reboot after export]" "[Another Server]" )
MYMAIL=root
VBOXMANAGE="/usr/bin/VBoxManage -q"
# =======================================================
# Generate a list of all VMs
for VM in $(vboxmanage list vms | rev | cut -d' ' -f1 | rev); do


  ERR="nothing"
  SECONDS=0
  # Get VM's friendly name
  FRIENDLYNAME=$(vboxmanage showvminfo --machinereadable $VM | grep -m1 "name=" | cut -d'"' -f2)
  echo "$VM's friendly name is: $FRIENDLYNAME." &>> $LOGFILE
  # Get the vm state
  VMSTATE=$(vboxmanage showvminfo $VM --machinereadable | grep "VMState=" | cut -f 2 -d "=")
  echo "$FRIENDLYNAME's state is: $VMSTATE." &>> $LOGFILE
  # If the VM's state is running or paused, save its state
  if [[ $VMSTATE == \"running\" || $VMSTATE == \"paused\" ]]; then
    echo "Saving State of $FRIENDLYNAME." &>> $LOGFILE
    vboxmanage controlvm $FRIENDLYNAME savestate &>> $LOGFILE
    if [ $? -ne 0 ]; then ERR="saving the state"; fi
  fi
  # Export the vm as appliance
  if [ "$ERR" == "nothing" ]; then
    echo "Exporting $FRIENDLYNAME." &>> $LOGFILE
    vboxmanage export $FRIENDLYNAME --output $EXPORTDIR/$FRIENDLYNAME-new.ova &>> $LOGFILE
    if [ $? -ne 0 ]; then
      ERR="exporting"
    else
      # Remove old backup and rename new one
      if [ -e $EXPORTDIR/$FRIENDLYNAME.ova ]; then rm $EXPORTDIR/$FRIENDLYNAME.ova; fi
      mv $EXPORTDIR/$FRIENDLYNAME-new.ova $EXPORTDIR/$FRIENDLYNAME.ova &>> $LOGFILE
      # Get file size
      FILESIZE=$(du -h $EXPORTDIR/$FRIENDLYNAME.ova | cut -f 1)
    fi
  else
    echo "Not exporting because the VM's state couldn't be saved." &>> $LOGFILE
  fi
  # Resume the VM to its previous state if that state was paused or running
  if [[ $VMSTATE == \"running\" || $VMSTATE == \"paused\" ]]; then
    vboxmanage startvm $FRIENDLYNAME --type headless &>> $LOGFILE
    if [ $? -ne 0 ]; then ERR="resuming"; fi
    if [ $VMSTATE == \"paused\" ]; then
      vboxmanage controlvm $FRIENDLYNAME pause &>> $LOGFILE
      if [ $? -ne 0 ]; then ERR="pausing"; fi
    fi
  fi
  # If machine is SRV03 and VMSTATE was not powered off or paused then reboot the machine to recover for instance the USB port.
  for val in "${REBOOT[@]}"; do
	if [[ $FRIENDLYNAME == $val && $VMSTATE != \"paused\" && $VMSTATE != \"poweroff\" ]]; then
		echo "$FRIENDLYNAME needs a reboot... Doing an ACPIshutdown and start of $FRIENDLYNAME." &>> $LOGFILE
		vboxmanage controlvm $FRIENDLYNAME acpipowerbutton &>> $LOGFILE
		until [[ $(VBoxManage showvminfo --machinereadable $FRIENDLYNAME | grep ^VMState=.poweroff.) || $(VBoxManage showvminfo --machinereadable $FRIENDLYNAME | grep ^VMState=.aborted.) ]]; do
			VBoxManage showvminfo --machinereadable $FRIENDLYNAME | grep ^VMState= &>> $LOGFILE
			sleep 1
		done
		if [ $? -ne 0 ]; then ERR="poweroff"; fi
		vboxmanage startvm $FRIENDLYNAME --type headless &>> $LOGFILE
		if [ $? -ne 0 ]; then ERR="starting"; fi
	fi
  done
  # Calculate duration
  duration=$SECONDS
  duration="$(($duration / 60)) minutes, $(($duration % 60)) seconds."
  # Notify the admin
  if [ "$ERR" == "nothing" ]; then
	echo "Virtual Machine $FRIENDLYNAME was exported successfully!" &>> $LOGFILE
	echo "Time it took to export $FRIENDLYNAME was: $duration" &>> $LOGFILE
	echo "Filesize of $FRIENDLYNAME.ova is: $FILESIZE" &>> $LOGFILE
	MAILBODY="Virtual Machine $FRIENDLYNAME was exported successfully!"
    MAILBODY="$MAILBODY"$'\n'"$duration"
    MAILBODY="$MAILBODY"$'\n'"Export filesize: $FILESIZE"
    MAILSUBJECT="VM $FRIENDLYNAME successfully backed up"
  else
	echo "There was an error in $ERR of $FRIENDLYNAME." &>> $LOGFILE
	MAILBODY="There was an error in $ERR of $FRIENDLYNAME."
    if [ "$ERR" == "exporting" ]; then
      MAILBODY=$(echo $MAILBODY && cat $LOGFILE)
    fi
    MAILSUBJECT="Error exporting VM $FRIENDLYNAME"
  fi
  # Send the mail
  echo "$MAILBODY" | mail -s "$MAILSUBJECT" $MYMAIL
done