summarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevdog2019-11-20 11:10:00 -0600
committerKevdog2019-11-20 11:10:00 -0600
commit014976b84b355c36391a7a4cdc5d375be796dda0 (patch)
tree7a0ab466dc2019487794287fbf404fb7f9356275
parent037a8774adad3f627ef99b7240f38b38e8fc4688 (diff)
downloadaur-014976b84b355c36391a7a4cdc5d375be796dda0.tar.gz
modified: README.md
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 96f6a055a6b..dd79479cef8 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,16 @@
# xe-guest-utilities-git
-### Purpose
+## Purpose
xe-guest-utilities is an add-on package for the [Xen](https://xenproject.org/developers/teams/xen-hypervisor/) and [xcp-ng](https://xcp-ng.org/) hypervisors. As per [documentation](https://xenproject.org/developers/teams/xen-hypervisor/) these tools:
- Report extra VM info (that only the Operating system can know, not your underlying hypervisor), like VM IP address, kernel version etc.
- Communicate with the OS in case of quiesce snapshots (Windows and its VSS)
- Allow sending signals to the OS (clean reboot, hotplug hardware etc.)
This package provides a service file which can be activated/enabled by systemd to provide these features to your VM running with Xen/xcp-ng.
-### Source Code
+## Source Code
xe-guest-utilities pulls its sourcecode from the [Xenserver](https://github.com/xenserver/xe-guest-utilities) github repository. The source code requires a [Go development environment](https://golang.org/doc/install) in order to successfully compile the code. This script should automatically download the go-pie package, compile and install the script.
-### Installation
+## Installation
The PKGBUILD file is hosted on [github](https://github.com/kevdogg/xe-guest-utilities-git) and listed in the [AUR](https://aur.archlinux.org/packages/xe-guest-utilities-git/). The package file can be installed via:
- Manual Installation - Download PKGBUILD, `makepkg -si` -- [Instructions for Manual Installation of PKGBUILD files](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages)
- Automated Installation - Through use of AUR Helper Utilities(yay, trizen, pacaur, etc) [AUR Helper List](https://wiki.archlinux.org/index.php/AUR_helpers)
@@ -28,7 +28,7 @@ The following files are installed by the package: (Listed here in case manual re
- /usr/bin/xenstore-write
-### Activation
+## Activation
Once xe-guest-utilities-git is installed, the service can be started (as root):
```
systemctl start xe-guest-utilities.service
@@ -39,7 +39,7 @@ The service can be enabled so it will start on subsequent boots:
systemctl enable xe-guest-utilities.service
```
-References:
+### References:
1. https://github.com/xcp-ng/xcp/wiki/Guest-Tools
2. https://github.com/xcp-ng/xe-guest-utilities
3. https://xen-orchestra.com/blog/install-xenserver-tools-in-your-vm/