1 Commits

Author SHA1 Message Date
Dustin B
f9905a50a9 Update xo_install.sh 2018-08-17 08:47:21 -04:00
7 changed files with 88 additions and 197 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.

View File

@@ -71,7 +71,7 @@ further defined and clarified by project maintainers.
### Enforcement ### Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at xogithub@gmail.com. All reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident. obligated to maintain confidentiality with regard to the reporter of an incident.

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,93 +1,30 @@
# Xen-Orchestra (Community Edition) Installer # 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 sudo bash
* 3 GiB RAM <password>
* 10 GiB disk space sudo curl https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xo_install.sh | bash
<password>
## 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.
sudo bash
bash -c "$(curl https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xo_install.sh)"
The default username and password are applied, admin@admin.net and admin for the 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```. If you don't want NFS capabilities run ```sudo apt-get remove nfs-common```.
* Do not use LAMP * Do not use LAMP
* SSH Access is optional, but highly recommended * SSH Access is optional, but highly recommended
## Updates
To maintain your installation from Source or from this repo. (either prepackaged or scripted installation) we recommend using the update script which this community maintains. This can be [found here](https://github.com/Jarli01/xenorchestra_updater) and doesn't require you to download or install a separate package to your XOCE installation. Simply run it via shell session of your XOCE host.
# Declarations
This script automates the manual process which can be [found here](https://docs.xen-orchestra.com/installation) 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.
# 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 # 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. 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. 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. 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.
While the goal initially was to have a solution as close to XOA as possible, with the script came the ability and goal to automate the installation. This is a big deal for these scripts today, while providing an as near-match solution to XOA as possible. While the goal initially was to have a solution as close to XOA as possible, with the script came the ability and goal to automate the installation. This is a big deal for these scripts today, while providing an as near-match solution to XOA as possible.
To keep XOCE up to date I recommend that anyone who's used this installation script or the sources installation to use this: https://github.com/Jarli01/xenorchestra_updater
## Adding XOCE v6 to your installation (this is a Work In Progress by Vates)
cd /opt/xen-orchestra
yarn run turbo run build --filter @xen-orchestra/web
Once the installation is completed, you can then go to [https://your-host-ip/v6](https://your-host-ip/v6)

View File

@@ -1,18 +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) # XO Website not loading
## 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
If the XO website fails to load please run the below command to determine if the primary service is running.
systemctl status xo-server.service systemctl status xo-server.service
@@ -29,7 +17,7 @@ If the XO website fails to load please run the below command to determine if the
CGroup: /system.slice/xo-server.service CGroup: /system.slice/xo-server.service
└─710 /usr/local/bin/node ./bin/xo-server └─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: 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 +26,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. 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. 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 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. 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.
@@ -57,15 +45,5 @@ Check your distribution respositories list ie: ```/etc/apt/sources.list``` for m
* python-minimal * python-minimal
* libvhdi-utils * libvhdi-utils
* nfs-common * nfs-common
* lvm2
* cifs-utils
These dependencies (on Ubuntu) are available from the ```multiverse``` and ```universe``` repositories. These dependencies (on Ubuntu) are available from the ```multiverse``` and ```universe``` repositories.
## 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.
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,80 +3,73 @@
# Check if we were effectively run as root # Check if we were effectively run as root
[ $EUID = 0 ] || { echo "This script needs to be run as root!"; exit 1; } [ $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) totalk=$(awk '/^MemTotal:/{print $2}' /proc/meminfo)
if [ "$totalk" -lt "2000000" ]; then echo "XOCE Requires at least 2GB 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) distro=$(/usr/bin/lsb_release -is)
if [ "$distro" = "Ubuntu" ]; then /usr/bin/add-apt-repository multiverse; fi if [ "$distro" = "Ubuntu" ]; then /usr/bin/add-apt-repository multiverse; fi
xo_branch="master" xo_branch="master"
xo_server="https://github.com/vatesfr/xen-orchestra" 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 [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main" 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" yarn_gpg="https://dl.yarnpkg.com/debian/pubkey.gpg"
n_location="/usr/local/bin/n" n_location="/usr/local/bin/n"
xo_server_dir="/opt/xen-orchestra" xo_server_dir="/opt/xen-orchestra"
systemd_service_dir="/lib/systemd/system" systemd_service_dir="/lib/systemd/system"
xo_service="xo-server.service" 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 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 cd /opt
/usr/bin/curl -sSL $yarn_gpg | gpg --dearmor | tee /usr/share/keyrings/yarnkey.gpg >/dev/null /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 echo "$yarn_repo" | tee /etc/apt/sources.list.d/yarn.list
/usr/bin/apt-get update /usr/bin/apt-get update
/usr/bin/apt-get install --yes yarn /usr/bin/apt-get install --yes nodejs yarn
# Install n #Install n
/usr/bin/curl -o $n_location $n_repo /usr/bin/curl -o $n_location $n_repo
/bin/chmod +x $n_location /bin/chmod +x $n_location
/usr/local/bin/n lts
# Install node via n #Symbolic Link
n lts
# Symlink node directories
ln -s /usr/bin/node /usr/local/bin/node ln -s /usr/bin/node /usr/local/bin/node
# Install XO dependencies #node_modules directory creation
/usr/bin/apt-get install --yes build-essential redis-server libpng-dev git python3-minimal libvhdi-utils nfs-common lvm2 cifs-utils openssl libfuse2t64 mkdir /usr/local/lib/node_modules/
#Install XO dependencies
/usr/bin/apt-get install --yes build-essential redis-server libpng-dev git python-minimal libvhdi-utils nfs-common
/usr/bin/git clone -b $xo_branch $xo_server /usr/bin/git clone -b $xo_branch $xo_server
# 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 cd $xo_server_dir
/usr/bin/yarn /usr/bin/yarn
/usr/bin/yarn build /usr/bin/yarn build
cd packages/xo-server cd packages/xo-server
cp sample.config.toml .xo-server.toml cp sample.config.yaml .xo-server.yaml
sed -i "s|#'/': '/path/to/xo-web/dist/'|'/': '/opt/xen-orchestra/packages/xo-web/dist'|" .xo-server.yaml
dest=/usr/local/lib/node_modules/ # symlink all plugins
#Create node_modules directory if doesn't exist for source in =$(ls -d /opt/xen-orchestra/packages/xo-server-*); do
mkdir -p $dest ln -s "$source" /usr/local/lib/node_modules/
# Plugins to ignore
ignoreplugins=("xo-server-test")
# 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
done done
if [[ -e $systemd_service_dir/$xo_service ]] ; then if [[ ! -e $systemd_service_dir/$xo_service ]] ; then
rm $systemd_service_dir/$xo_service
fi
/bin/cat << EOF >> $systemd_service_dir/$xo_service /bin/cat << EOF >> $systemd_service_dir/$xo_service
# Systemd service for XO-Server. # systemd service for XO-Server.
[Unit] [Unit]
Description= XO Server Description= XO Server
@@ -84,15 +77,14 @@ After=network-online.target
[Service] [Service]
WorkingDirectory=/opt/xen-orchestra/packages/xo-server/ WorkingDirectory=/opt/xen-orchestra/packages/xo-server/
ExecStart=/usr/local/bin/node ./dist/cli.mjs ExecStart=/usr/local/bin/node ./bin/xo-server
Restart=always Restart=always
SyslogIdentifier=xo-server SyslogIdentifier=xo-server
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
EOF EOF
fi
/bin/systemctl daemon-reload /bin/systemctl daemon-reload
/bin/systemctl enable $xo_service /bin/systemctl enable $xo_service

View File

@@ -1,6 +1,6 @@
#!/bin/bash #!/bin/bash
XOCE_URL=https://nc.nl.tab.digital/s/WQmCwmH4e9EdTTA/download XOCE_URL=https://drive.google.com/uc?export=download&confirm=ktXq&id=1eKz78LjkmrMHU95OC3qiQpPLuryJ2TEK
# Welcome message # Welcome message
printf "\n\033[1mWelcome to the XOCE auto-deploy script!\033[0m\n\n" printf "\n\033[1mWelcome to the XOCE auto-deploy script!\033[0m\n\n"
@@ -10,7 +10,7 @@ then
echo echo
echo 'Sorry, the xe command is required for this auto-deploy.' echo 'Sorry, the xe command is required for this auto-deploy.'
echo echo
echo 'Please, make sure you are on a XCP-ng/XenServer host.' echo 'Please, make sure you are on a XenServer host.'
echo echo
exit 1 exit 1
fi fi
@@ -18,8 +18,8 @@ fi
# Basic check: are we on a XS host? # Basic check: are we on a XS host?
if grep -Fxq "XenServer" /etc/issue if grep -Fxq "XenServer" /etc/issue
then then
printf "\nSorry, it seems you are not on a XCP-ng/XenServer host.\n\n" printf "\nSorry, it seems you are not on a XenServer (XCP-ng) host.\n\n"
printf "\n\033[1mThis script is meant to be deployed on XCP-ng or XenServer only.\033[0m\n\n" printf "\n\033[1mThis script is meant to be deployed on XenServer (or XCP-ng) only.\033[0m\n\n"
exit 1 exit 1
fi fi
@@ -36,7 +36,7 @@ then
read -p "dns? [8.8.8.8] " dns read -p "dns? [8.8.8.8] " dns
dns=${dns:-8.8.8.8} dns=${dns:-8.8.8.8}
else else
printf "\nYour XOCE installation will be started using DHCP\n\n" printf "\nYour XOCE will be started using DHCP\n\n"
fi fi
# Downloading and importing the VM # Downloading and importing the VM
@@ -56,7 +56,7 @@ fi
import=$? import=$?
if [ $import -ne 0 ] if [ $import -ne 0 ]
then then
printf "\n\nAuto deploy failed. Please contact us on https://github.com/Jarli01/xenorchestra_installer/issues for assistance.\nError:\n\n %s\n\n" "$uuid" printf "\n\nAuto deploy failed. Please contact us on xen-orchestra.com live chat for assistance.\nError:\n\n %s\n\n" "$uuid"
exit 0 exit 0
fi fi
@@ -75,7 +75,7 @@ sleep 2
# Waiting for the VM IP from Xen tools for 60 secs # Waiting for the VM IP from Xen tools for 60 secs
printf "Waiting for XOCE to be ready…\n" printf "Waiting for your XOCE to be ready…\n"
url=$(xe vm-param-get uuid=$uuid param-name=networks param-key=0/ip 2> /dev/null) url=$(xe vm-param-get uuid=$uuid param-name=networks param-key=0/ip 2> /dev/null)
wait=0 wait=0
limit=60 limit=60
@@ -95,7 +95,7 @@ done
if [ "$ip" != 'dhcp' ] if [ "$ip" != 'dhcp' ]
then then
printf "\n\033[1mYour XOCE is ready at https://%s/\033[0m\n" "$ip" printf "\n\033[1mYour XOCE is ready on https://%s/\033[0m\n" "$ip"
# clean the xenstore data # clean the xenstore data
xe vm-param-remove param-name=xenstore-data param-key=vm-data/dns param-key=vm-data/ip param-key=vm-data/netmask param-key=vm-data/gateway uuid=$uuid xe vm-param-remove param-name=xenstore-data param-key=vm-data/dns param-key=vm-data/ip param-key=vm-data/netmask param-key=vm-data/gateway uuid=$uuid
@@ -105,7 +105,7 @@ elif [ -z "$url" ]
then then
printf "\n\033[1mYour XOCE booted but we couldn't fetch its IP address\033[0m\n" printf "\n\033[1mYour XOCE booted but we couldn't fetch its IP address\033[0m\n"
else else
printf "\n\033[1mYour XOCE is ready at https://%s/\033[0m\n" "$url" printf "\n\033[1mYour XOCE is ready on https://%s/\033[0m\n" "$url"
fi fi
printf "\nDefault UI credentials: admin@admin.net/admin\nDefault console credentials: xoce/xoce\n" printf "\nDefault UI credentials: admin@admin.net/admin\nDefault console credentials: xoce/xoce\n"
printf "\nVM UUID: %s\n\n" "$uuid" printf "\nVM UUID: %s\n\n" "$uuid"