How To: Install and Enable the CloudLinux Plugin for InterWorx
==============================================================

InterWorx provides a plugin for CloudLinux, which allows both NodeWorx and SiteWorx users the ability to
access and manage various CloudLinux services.

.. contents:: 

To Install the CloudLinux Plugin
--------------------------------

#. Log in to the server at the CLI as root, either via SSH or from the terminal
#. Install CloudLinux with the installer script:

   .. code-block::

      wget https://repo.cloudlinux.com/cloudlinux/sources/cln/cldeploy

#. Activate the CloudLinux license 

   - If using an activation key:

     .. code-block::

        sh cldeploy -k [activation_key]


   - If using an IP based license:

     .. code-block::

        sh cldeploy -i


#. Install the InterWorx CloudLinux plugin with the following:

   .. code-block::

      yum install interworx-plugin-cloudlinux


#. Reboot the server:

   .. code-block::

      reboot


#. (Optional) CageFS and the multiple PHP versions that are provided by CloudLinux
   can be enabled and installed from the GUI. However, if desired, they can
   also be installed manually at the command line. To do so, run the following
   as root:

   - To install and enable CageFS:

     .. warning::

        If accessing root via a sudo or su user, be sure to add the user to
        ``/etc/cagefs/exclude/systemuserlist`` or ``/etc/cagefs/exclude/interworx``.
        Before running ``cagefsctl --init``.

     .. code-block::

        yum install cagefs -y --disablerepo=remi* -y
        cagefsctl --init
        cagefsctl --enable-cagefs

   
   More information on using CageFS from the command line can be found `here
   <https://docs.cloudlinux.com/command-line_tools/#cagefs>`__.

   - To install all CloudLinux PHP versions:

     .. code-block::

       yum groupinstall alt-php --disablerepo=remi* -y

#. (Optional) Customers who would like to enable python and/or nodejs selectors must first install the ``alt-mod-passenger``
   package. This task can only be completed at the CLI, with the following command: 

   .. code-block::

      yum install alt-mod-passenger

Enabling the CloudLinux Plugin in NodeWorx
------------------------------------------

#. Once the installation is complete, log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)
#. In NodeWorx, navigate to **NodeWorx > Plugins**
#. Under Miscellaneous, click the **Pencil** next to CloudLinux LVE Manager. This opens the Edit Plugin form
#. Select **Enabled** from the Status dropdown 

   .. image:: /images/cloudlinux-plugin-enable.png

#. Click **Save**

Using the CloudLinux Plugin in NodeWorx (LVE Manager)
-----------------------------------------------------

After the plugin is enabled, CloudLinux tools can be found in NodeWorx under **CloudLinux > Lve Manager** in the side menu

CloudLinux Installation Wizard
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The CloudLinux Installation Wizard will automatically display when accessing
the LVE Manager for the first time. It allows for to easily installation and
set up of CloudLinux OS components on InterWorx.

.. image:: /images/cloudlinux-configuration-wizard.png

More information on the Cloud Linux Installation Wizard can be found `here
<https://docs.cloudlinux.com/lve_manager/#cloudlinux-installation-wizard>`__.

LVE Manager
^^^^^^^^^^^

.. image:: /images/cloudlinux-lve-manager.png

From the LVE Manger, the following controls can be managed:

- Current Usage
- Users
- CageFS user Management 
- Statistics
- CloudLinux PHP Selector

  .. note:: 
     
     In order for CloudLinux PHP versions to be available to SiteWorx accounts, the System PHP Mode must be set to 
     mod_suphp on the Web Server page in NodeWorx

  To set the System PHP Mode: 

  #. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)
  #. In NodeWorx, navigate to **System Services > Web Server > Overview**
  #. Under PHP Integration Mode, select **mod_suphp** from the PHP Mode dropdown

     .. image:: /images/phpmode.png

  #. Click **Update**

  .. note:: 
     
     SiteWorx accounts must be added to CageFS, first, in order for CloudLinux PHP options to be available in SiteWorx

- Nodejs and Python installation

Logging Related to CloudLinux
-----------------------------

Logs generated by InterWorx related to the CloudLinux plugin may be viewed from both the CLI and from the NodeWorx
Interface. 

To View CloudLinux Logging From the CLI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Log in to the server at the CLI as root, either via SSH or from the terminal
#. In a text editor, open ``~iworx/var/log/cloudlinux.log``

   .. code-block::

      vim ~iworx/var/log/cloudlinux.log


To View CloudLinux Logging in NodeWorx
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)
#. In NodeWorx, navigate to **NodeWorx > Server > Logs**
#. Select **InterWorx Logs** from the Select Log Group dropdown
#. Click **Continue**. This opens the Log Settings page
#. Select **cloudlinux.log** from the Log File dropdown
#. Click **Show Log**