Improve docs

Author: Core-i99

Fedora.md

@@ -1,3 +1,6 @@
+## Diable cockpit
+- ``systemctl disable --now cockpit.socket``
+
 ## Install packages
 - gcc
 - python3-devel
@@ -38,8 +41,48 @@ Note: connecting may take some time
 - ``virsh net-start br0``
 - ``virsh net-autostart br0``
 
+## Download VmManager
+```
+#!/usr/bin/env bash
+
+# Authorize to GitHub to get the latest release tar.gz
+# Requires: oauth token, https://help.github.com/articles/creating-an-access-token-for-command-line-use/
+# Requires: jq package to parse json
+
+# Your oauth token goes here, see link above
+OAUTH_TOKEN="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"
+# Repo owner (user id)
+OWNER="macOS-KVM"
+# Repo name
+REPO="VmManager"
+# The file name expected to download. This is deleted before curl pulls down a new one
+FILE_NAME="VmManager-build.zip"
+
+# Concatenate the values together for a
+API_URL="https://$OAUTH_TOKEN:@api.github.com/repos/$OWNER/$REPO"
+
+# Gets info on latest release, gets first uploaded asset id of a release,
+# More info on jq being used to parse json: https://stedolan.github.io/jq/tutorial/
+ASSET_ID=$(curl $API_URL/releases/latest | jq -r '.assets[0].id')
+echo "Asset ID: $ASSET_ID"
+
+# curl does not allow overwriting file from -O, nuke
+rm -f $FILE_NAME
+
+# curl:
+# -O: Use name provided from endpoint
+# -J: "Content Disposition" header, in this case "attachment"
+# -L: Follow links, we actually get forwarded in this request
+# -H "Accept: application/octet-stream": Tells api we want to dl the full binary
+curl -O -J -L -H "Accept: application/octet-stream" "$API_URL/releases/assets/$ASSET_ID"
+``` 
+
+
 ## Install python modules
 - ``pip3 install -r requirements.txt``
 
-## Start VmManager
-- ``python3 VmManager.py``
+## Disable firewall
+- ``systemctl disable --now firewalld``
+
+## Done
+- Follow the instructions in the README.md file to run VmManager

README.md

@@ -4,8 +4,30 @@ Web UI for managing libvirt based virtual machines
 ## Usage (production)
 - Download the latest release
 - Extract the archive
+- Run `python3 init_database.py`
 - Run `gunicorn --worker-class gevent -w 1 main:app --bind :80`
 
 ## Usage (development)
 - Download the source code
+- Run `python3 init_database.py`
 - Run `python3 main.py`
+
+## Run as a service
+- Create a file named `VmManager.service` in `/etc/systemd/system/`
+- Copy the following content into the file
+```
+[Unit]
+Description=VmManager
+After=multi-user.target
+[Service]
+Type=simple
+Restart=always
+ExecStart=gunicorn --worker-class gevent -w 1 main:app --bind :80
+WorkingDirectory=/path/to/VmManager
+[Install]
+WantedBy=multi-user.target
+```
+- Replace `/path/to/VmManager` with the path to the VmManager directory
+- Run `systemctl daemon-reload`
+- Run `systemctl enable --now VmManager.service`
+- Run `systemctl status VmManager.service` to check if the service is running

backend/main.py

@@ -2252,9 +2252,14 @@ class api_host_system_info(Resource):
     def get(self, action):
         if action == "all":
             sysInfo = ET.fromstring(conn.getSysinfo(0))
-            baseboard_manufacturer = sysInfo.find("baseBoard/entry[@name='manufacturer']").text
-            baseboard_product = sysInfo.find("baseBoard/entry[@name='product']").text
-            baseboard_version = sysInfo.find("baseBoard/entry[@name='version']").text
+            # if baseboard exists in sysinfo
+            baseboard_manufacturer = "Unknown"
+            baseboard_product = ""
+            baseboard_version = ""
+            if sysInfo.find("baseBoard") is not None:
+                baseboard_manufacturer = sysInfo.find("baseBoard/entry[@name='manufacturer']").text
+                baseboard_product = sysInfo.find("baseBoard/entry[@name='product']").text
+                baseboard_version = sysInfo.find("baseBoard/entry[@name='version']").text
             processor_version = sysInfo.find("processor/entry[@name='version']").text
             memory_size = sysInfo.find("memory_device/entry[@name='size']").text
             return {

requirements.txt backend/requirements.txtrequirements.txt renamed to backend/requirements.txt

@@ -12,3 +12,4 @@ flask-jwt-extended
 python-pam
 gevent
 gunicorn
+LibvirtKVMBackup