.. _install:

*********************
Installing the System
*********************

Please refer to the section :ref:`Troubleshooting <troubleshooting>` if ever you have errors during the installation.

There are two official ways to install XiVO:

* using the official ISO image
* using a minimal Debian installation and the XiVO installation script

XiVO can be installed on both virtual (QEMU/KVM, VirtualBox, ...) and physical machines. That said, since
Asterisk is sensitive to timing issues, you might get better results by installing XiVO on real
hardware.


Installing from the ISO image
=============================

.. note:: Our ISO image does not support UEFI system

* Download the ISO image. (`all versions`_)
* Boot from the ISO image, select ``Install`` and follow the instructions. You must select a locale
  with charset UTF-8.
* At the end of the installation, you can continue by running the :ref:`configuration
  wizard. <configuration_wizard>`

During the installation of Debian, only a proxy that supports proxying http/https requests may eventually be entered.
Otherwise GPG key of XiVO repository will not be installed and must be added manually::

   wget http://mirror.xivo.solutions/xivo_current.key -O - | apt-key add -

.. _all versions: http://mirror.xivo.solutions/iso/archives


Installing from a minimal Debian installation
=============================================

XiVO can be installed directly over a **32-bit** or a **64-bit** Debian jessie. When doing so, you are strongly
advised to start with a clean and minimal installation of Debian jessie.

The latest installation image for Debian jessie can be found at https://www.debian.org/releases/jessie/debian-installer.


Requirements
^^^^^^^^^^^^

The installed Debian must:

* use the architecture ``i386`` or ``amd64``
* have a default locale with charset UTF-8

In case you want to migrate a XiVO from ``i386`` to ``amd64``, see :ref:`migrate_i386_to_amd64`.


Installation
^^^^^^^^^^^^

Once you have your Debian jessie properly installed, download the XiVO installation script and make
it executable::

   wget http://mirror.xivo.solutions/xivo_install.sh
   chmod +x xivo_install.sh

If the script is run without a modifier, it installs the latest LTS version::

   ./xivo_install.sh

To install XiVO *Five*, run::

   ./xivo_install.sh -a 2017.03-latest   

At the end of the installation, you can continue by running the :ref:`configuration
wizard. <configuration_wizard>`


Alternatives versions
^^^^^^^^^^^^^^^^^^^^^

The installation script can also be used to install an :ref:`archive version <archive-version>` of
XiVO (14.18 or later only). For example, if you want to install XiVO 16.03::

   ./xivo_install.sh -a 16.03

When installing an archive version, note that:

* versions 14.18 to 15.19 of XiVO can only be installed on a Debian 7 (wheezy) system
* the 64-bit versions of XiVO are only available starting from 15.16

You may also install development versions of XiVO with this script. These versions may be unstable
and should not be used on a production server. Please refer to the usage of the script::

   ./xivo_install.sh -h


Other installation methods
==========================

It's also possible to install XiVO by PXE. It is not documented here.