diff --git a/README.md b/README.md index 83e0306..0057c3d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,33 @@ # Xen-Orchestra (Community Edition) Installer -Xen-Orchestra (Community Edition) allows you to administer Citrix XenServer and XCP-ng as well as backup any VM's running on these systems. +Xen-Orchestra (Community Edition) allows you to administer Citrix Hypervisor (aka XenServer) and XCP-ng as well as backup any VM's running on these systems. The single line installation script allows you to go from a bare-minimal installation of [Ubuntu](https://ubuntu.com/download/server) or [Debian (Server)](https://www.debian.org/distrib/netinst) to fully operational XOCE server. -The single line installation script allows you to go from a bare-minimal installation of [Ubuntu](https://ubuntu.com/download/server) or [Debian (Server)](https://www.debian.org/distrib/netinst) to fully operational XOCE server. Run the following steps from a root shell. +## System Minimum Requirements for installation + +* 1 vCPU +* 3 GiB RAM +* 10 GiB disk space + +## System Recommendations for operation + +* 2 vCPU recommended +* 3 GiB of RAM (for environments containing 500+ VMs increase the XOCE RAM) +* 20 GiB disk space (for system updates) + +## Assumptions + +* We assume you have a Virtual or physical server running a currently supported Ubuntu or Debian server installation with internet connectivity +* You've read this community and understand what installation entails and does on your soon to be XOCE server + +## Installation + +Run the following steps from a root shell on your **Ubuntu or Debian** host. curl https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xo_install.sh | sudo bash The default username and password are applied, admin@admin.net and admin for the password - + If you don't want NFS capabilities run ```sudo apt-get remove nfs-common```. * Do not use LAMP