2 Commits

Author SHA1 Message Date
Dustin B
db573519ee Update xo_install.sh 2019-06-17 11:26:11 -04:00
Dustin B
d25a71ef9a Direct people to this GH news issues page first rather than leaving the default of vatesfr
As a means of hopefully avoiding more banners/warnings/odd modifications from the dev team and a recent conversation with Olivier this change is being pushed as a means to get users of this script to come here for help first and the team here can elevate to vatesfr if so required.
2019-05-01 16:02:58 -04:00
6 changed files with 73 additions and 167 deletions

View File

@@ -1,50 +0,0 @@
---
name: Bug report
about: Create a report to help us help you
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the trouble is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop/Server details (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.
**Confirm XOCE services are running**
Please run ```systemctl status xo-server.service``` and paste the resulting output below.
**Provide the output of journalctl logs**
Please run ```journalctl -u xo-server -f -n 50``` and paste the resulting output below.
**Provide answers to these questions:**
* Is this a fresh install or an upgrade?
* Version of XOCE server and web interface you're running
* What OS is XOCE running on?
* A link to the ISO you've used as as the server (so we can verify/troubleshoot)
* What method did you use to install XOCE (xo_install.sh, manual installation, etc)
* What specific XOCE page you're on, and what specific element you're interacting with to trigger the error
* If a stacktrace is provided in the error, include that too.
* Any errors that appear in your browser's error console.
* Include what you've done so far in the installation, and if you got any error messages along the way.
* Indicate whether or not you've manually edited any data directly.

34
ISSUE_TEMPLATE.md Normal file
View File

@@ -0,0 +1,34 @@
#### Expected Behavior
<!-- what you expect to happen goes here -->
-----
#### Actual Behavior
<!-- what actually happens goes here -->
-----
#### Confirm XOCE services are running
```systemctl status xo-server.service```
#### Provide the output of journalctl logs
```journalctl -u xo-server -f -n 50```
#### Provide answers to these questions:
- Is this a fresh install or an upgrade?
- Version of XOCE server and web interface you're running
- What OS is XOCE running on?
- What method you used to install XOCE (xo_install.sh, manual installation, etc)
- What specific XOCE page you're on, and what specific element you're interacting with to trigger the error
- If a stacktrace is provided in the error, include that too.
- Any errors that appear in your browser's error console.
- Include what you've done so far in the installation, and if you got any error messages along the way.
- Indicate whether or not you've manually edited any data directly.
<!-- Please do not post an issue without answering the related questions above. If you have opened a different issue and already answered these questions, answer them again, once for every ticket. It will be next to impossible for us to help you. -->

View File

@@ -1,97 +1,28 @@
# Xen-Orchestra (Community Edition) Installer
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.
Xen-Orchestra (Community Edition) allows you to administer Citrix XenServer and XCP-ng as well as backup any VM's running on these systems.
## System Minimum Requirements for installation
The single line installation script allows you to go from a bare-minimal installation of Ubuntu or Debian (Server) to fully operational XOCE server. Run the following steps from a root shell.
* 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 amount 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
sudo bash
<password>
sudo curl https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xo_install.sh | bash
<password>
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
* SSH Access is optional, but highly recommended
# Declarations
This script automates the manual process which can be [found here](https://xen-orchestra.com/docs/from_the_sources.html) as well as removes a few feature restrictions that otherwise would need to be changed manually if following the manual installation process. This script is not officially supported by the Vates team, but is supported by this community.
# Prepacked installation
* *This is a very small installation and while it will operate, it may not meet all of your requirements, use at your own discretion*
To download and deploy a prepacked Ubuntu 20.04 installation of Xen Orchestra (CE) run the below from an SSH session on your XCP-NG/Citrix Hypervisor (XenServer) host(s)
bash -c "$(curl -s https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xoce-import.sh)"
MD5 Checksum `5db537c4b6388a4323583357b6e13d20`
SHA256 Checksum `c487d63f2eef67fcaf0e9c4e4998d4a3948fdad960cb1af5a70fcb80b07c2551`
For verification of SHA256 checksum the XVA file can be downloaded directly and verified/imported.
Direct Download https://srv-file8.gofile.io/download/CYaI0l/XOCE.xva
To login to the console use:
Username: **XOCE**
Password: **XOCE**
**Change the password if you are using this in production**
# Self-signed SSL
If you are running this internally and need SSL (recommended) follow the below steps to create a self-signed SSL key and certificate; while browsers will still say the connection is unsecured, this is because the certificate isn't from a public authority and is on your LAN. You can add this cert to your systems root authority if it want to to remove the warning. Alternatively a reverse proxy can be used for public facing installations.
## Generate your key and cert from your XOCE installation
sudo openssl req -x509 -nodes -days 3650 -newkey rsa:4096 -keyout /etc/ssl/private/key.pem -out /etc/ssl/certs/certificate.pem
Now edit the xo-server.toml file
vi /opt/xen-orchestra/packages/xo-server/.xo-server.toml
Comment-out or edit the port from 80 to 443 and add the cert and key to the appropriate locations within this file.
port = 443
cert = '/etc/ssl/certs/certificate.pem'
key = '/etc/ssl/private/key.pem'
Restart xo-server.service
systemctl restart xo-server.service
Reload your XOCE website using SSL (https://your-host-ip)
# Problems?
Check out our [Troubleshooting Page](https://github.com/Jarli01/xenorchestra_installer/blob/master/TROUBLESHOOTING.md)!
# Goals/Backstory for this script
I'm often asked "why can't this be run on CentOS or Fedora" to which my only reply is and has ever been: The goal was to be the XCP-ng of XS. Which means I wanted a solution that offered as much as XOA offers, while using what is available freely and from open sources. Without restrictions.
That isn't to say that this installation script won't work on other distributions, please contribute and help us to spread XOCE to other platforms.
Initially my goal was to simply setup and start using XOCE for a tiny production shop to be able to use an open source hypervisor (Citrix XenServer at the time) and have a management tool/backup solution. Which was initially [NAUBackup](https://github.com/NAUbackup/VmBackup) and XenCenter, when I found XOA and that there was an open source management solution and backup solution that wasn't script based I jumped for it, taking the manual installation process provided by Olivier and his team and automating it.
Initially my goal was to simply setup and start using XOCE for a tiny production shop to be able to use an open source hypervisor (Citrix XenServer at the time) and have a management tool/backup solution. Which was initially NAUBackup and XenCenter, when I found XOA and that there was an open source management solution and backup solution that wasn't script based I jumped for it, taking the manuall installation process provided by Olivier and his team and automating it.
That goal transformed into the desire to assist the developers of XOA by using and hopefully finding any bugs or quirks that needed to be worked out while staying in line with the original goal of being as nearly compatibile as possible to XOA.

View File

@@ -1,16 +1,6 @@
# Troubleshooting
If you are having issues before you create an issue please check the following. (We'll be asking you to look at and provide this information anyways)
If you are having problems, before you create an issue, please check the following. (You will be asked to provide this information anyways)
## Submitting a Support Request
Any issues, questions, or bugs during installation and usage of this script, that can not be solved by the steps below, should **first** be addressed in *this repository.*
Xen-Orchestra (VatesFR) is not obligated to support scripted (or manual) builds. Please give us the ability to first troubleshoot the issue and/or verify this script is not the culprit before moving on to posting in the Xen-Orchestra [Community Forums](https://xcp-ng.org/forum/category/12/xen-orchestra).
Please use the [ISSUE TEMPLATE](https://github.com/Jarli01/xenorchestra_installer/issues/new) when submitting an issue.
## XO Website not loading
# XO Website not loading
If the XO website fails to load please run the below command to determine if the primary service is running.
@@ -29,7 +19,7 @@ If the XO website fails to load please run the below command to determine if the
CGroup: /system.slice/xo-server.service
└─710 /usr/local/bin/node ./bin/xo-server
## XO not updating or you're stuck on a specific version.
# XO not updating or you're stuck on a specific version.
If you ever get stuck on a specific revision of XO, or are receiving an alert saying "Please tell us who you are" from git you need to run the below:
@@ -38,13 +28,13 @@ If you ever get stuck on a specific revision of XO, or are receiving an alert sa
Provide your name and email address in the quoted sections, without quotes and once done try updating again.
## Checking the logs
# Checking the logs
This will check and continually update the last 50 log files for your XOCE installation and thus is subject to any specific issues you're encountering. Just keep this command at the ready to check on things if you need too.
journalctl -u xo-server -f -n 50
## Required Dependencies
# Required Dependencies
Your system must be able to install the following list of dependencies, usually this is automatic but some distributions might not have the required repositories. Plese confirm you can install these before creating a ticket.
@@ -62,10 +52,10 @@ Check your distribution respositories list ie: ```/etc/apt/sources.list``` for m
These dependencies (on Ubuntu) are available from the ```multiverse``` and ```universe``` repositories.
## System Performance or General Errors Guidance
# System Performance or General Errors Guidance
While XOCE can and does operate without issue for many people there are benefits to using using more than the absolute minimum system specifications for the guest OS.
There is a mandate for 3 GB of ram built into the installation script. While this is a requirement of XO it isn't a requirement of the OS.
There is a mandate for 1 GB of ram built into the installation script. While this is a requirement of XO it isn't a requirement of the OS.
An additional check is being considered to match the XOA system which is supplied with 2 CPU (or 1 CPU with 2 cores). While this currently isn't implemented; if you encounter issues please try adding an additional CPU to your installation and see if the issue persists.

View File

@@ -3,72 +3,73 @@
# Check if we were effectively run as root
[ $EUID = 0 ] || { echo "This script needs to be run as root!"; exit 1; }
# Check for required memory
# Check for 1GB Memory
totalk=$(awk '/^MemTotal:/{print $2}' /proc/meminfo)
if [ "$totalk" -lt "3000000" ]; then echo "XOCE Requires at least 3GB Memory!"; exit 1; fi
if [ "$totalk" -lt "1000000" ]; then echo "XOCE Requires at least 1GB Memory!"; exit 1; fi
distro=$(/usr/bin/lsb_release -is)
if [ "$distro" = "Ubuntu" ]; then /usr/bin/add-apt-repository multiverse; fi
xo_branch="master"
xo_server="https://github.com/vatesfr/xen-orchestra"
n_repo="https://raw.githubusercontent.com/tj/n/master/bin/n"
n_repo="https://raw.githubusercontent.com/visionmedia/n/master/bin/n"
yarn_repo="deb https://dl.yarnpkg.com/debian/ stable main"
node_source="https://deb.nodesource.com/setup_8.x"
yarn_gpg="https://dl.yarnpkg.com/debian/pubkey.gpg"
n_location="/usr/local/bin/n"
xo_server_dir="/opt/xen-orchestra"
systemd_service_dir="/lib/systemd/system"
xo_service="xo-server.service"
# Ensures that Yarn dependencies are installed
# Ensure that git and curl are installed
/usr/bin/apt-get update
/usr/bin/apt-get --yes install git curl apt-transport-https gnupg
/usr/bin/apt-get --yes install git curl
#Install yarn
#Install node and yarn
cd /opt
/usr/bin/curl -sL $node_source | bash -
/usr/bin/curl -sS $yarn_gpg | apt-key add -
echo "$yarn_repo" | tee /etc/apt/sources.list.d/yarn.list
/usr/bin/apt-get update
/usr/bin/apt-get install --yes yarn
/usr/bin/apt-get install --yes nodejs yarn
# Install n
/usr/bin/curl -o $n_location $n_repo
/bin/chmod +x $n_location
# Install node via n
n lts
# Symlink node directories
ln -s /usr/bin/node /usr/local/bin/node
# Install XO dependencies
/usr/bin/apt-get install --yes build-essential redis-server libpng-dev git python2-minimal libvhdi-utils nfs-common lvm2 cifs-utils
/usr/bin/apt-get install --yes build-essential redis-server libpng-dev git python-minimal libvhdi-utils nfs-common lvm2 cifs-utils
/usr/bin/git clone -b $xo_branch $xo_server
# Removing the "Built from Source - no support banner
sed -i '225,235 d' /opt/xen-orchestra/packages/xo-web/src/xo-app/index.js
# Point people to this GH for issues first and we can escalte to vatesfr if so required
sed -i 's~https://github.com/vatesfr/xen-orchestra/issues/new~https://github.com/Jarli01/xenorchestra_installer/issues/new~g' /opt/xen-orchestra/packages/xo-web/src/xo-app/about/index.js
# Patch to allow config restore
sed -i 's/< 5/> 0/g' /opt/xen-orchestra/packages/xo-web/src/xo-app/settings/config/index.js
cd $xo_server_dir
/usr/bin/yarn
/usr/bin/yarn build
cd packages/xo-server
cp sample.config.toml .xo-server.toml
sed -i "s|#'/' = '/path/to/xo-web/dist/'|'/' = '/opt/xen-orchestra/packages/xo-web/dist'|" .xo-server.toml
dest=/usr/local/lib/node_modules/
#Create node_modules directory if doesn't exist
mkdir -p $dest
# Plugins to ignore
ignoreplugins=("xo-server-test")
mkdir -p /usr/local/lib/node_modules/
# Symlink all plugins
for source in $(ls -d /opt/xen-orchestra/packages/xo-server-*); do
plugin=$(basename $source)
if [[ "${ignoreplugins[@]}" =~ $plugin ]]; then
echo "Ignoring $plugin plugin"
else
ln -s "$source" "$dest"
fi
ln -s "$source" /usr/local/lib/node_modules/
done
if [[ ! -e $systemd_service_dir/$xo_service ]] ; then

View File

@@ -1,6 +1,6 @@
#!/bin/bash
XOCE_URL=https://cloud.wellston.biz/index.php/s/54tPkkkTcxQPnDs/download
XOCE_URL=https://archive.org/download/xogithub_gmail_Xoce/xoce
# Welcome message
printf "\n\033[1mWelcome to the XOCE auto-deploy script!\033[0m\n\n"
@@ -49,7 +49,7 @@ uuid=$(xe vm-import url="$XOCE_URL" 2> /dev/null)
import=$?
if [ $import -ne 0 ]
then
uuid=$(curl "$XOCE_URL" -L -O -c - --keepalive-time 5 | xe vm-import filename=/dev/stdin 2>&1)
uuid=$(curl "$XOCE_URL" | xe vm-import filename=/dev/stdin 2>&1)
fi
# If it fails again (for any reason), we stop the script