From 4e4da880d92fcdea8dcb85aceea63098cac6cd25 Mon Sep 17 00:00:00 2001
From: Jeff Clement <jeffrey.clement@gmail.com>
Date: Fri, 15 Nov 2024 11:20:18 -0700
Subject: [PATCH] Adding readme.

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..94a49f4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# XCP-ng Xen Tools Installer
+
+This repo is a quick installer for installing Xen Guest Tools 7.30.0-12 on a guest VM and is intended to be called from a CloudInit script without messing around with CD images.
+
+`xen-tools.tgz` is the raw content of the `Linux` folder of XCP-ng guest tools CD.  This script downloads this, and installs it.
+
+In CloudInit, it would be called with Runcmd like so:
+
+```
+runcmd:
+  - curl https://git.straybits.ca/straybits/xe-guest-utils-installer/raw/branch/main/install.sh | sh
+```
+
+A more complete example...
+
+```
+#cloud-config
+hostname: {name}
+manage_etc_hosts: true
+disable_root: false
+users:
+  - name: user
+    groups: sudo
+    sudo: ALL=(ALL) NOPASSWD:ALL
+    lock_passwd: false
+    passwd: $6$p
+    ssh_authorized_keys:
+      - ssh-rsa MY_SSH_KEY 
+    shell: /bin/bash
+  - name: root
+    ssh_authorized_keys:
+      - ssh-rsa MY_SSH_KEY 
+
+package_update: true
+package_upgrade: true
+
+packages:
+  - htop
+  - nano
+
+locale: en_US.UTF-8
+timezone: America/Edmonton
+runcmd:
+  - curl https://git.straybits.ca/straybits/xe-guest-utils-installer/raw/branch/main/install.sh | sh
+
+ssh_pwauth: False
+```
\ No newline at end of file