Documentation
Submit Request Try Free
Documentation: User interface (LVE Manager)

User interface (LVE Manager)

LVE Manager is a plugin for most popular control panels including cPanel, Plesk, DirectAdmin and ISPmanager (InterWorx coming soon). It allows you to control and monitor limits, and set limits on per package bases.

LVE Manager is installed by default on most servers. If it is missing you can always install it by running:

$ yum install lvemanager

CloudLinux installation wizard

Overview

CloudLinux Installation Wizard allows you to easily install and set up CloudLinux OS components on your server with cPanel, Plesk or DirectAdmin.

Set up

As you have CloudLinux OS installed, navigate to CloudLinux LVE Manager in your control panel. CloudLinux Installation Wizard starts automatically if lvemanager package is installed for the first time (not updated).

To start setting up your CloudLinux OS, click Start Wizard, otherwise click Skip Wizard, and you will be redirected to the LVE Manager Dashboard.

Note

Installation statuses of all components are duplicated inside their corresponding boxes on the Dashboard. All Wizard actions are available there as well. Dashboard will be automatically updated as soon as the installation process finishes.

The next step is selecting required components to be installed.

Click Finish and Install to complete installation or click Skip Wizard to go back to the Dashboard.

You can find a complete description of the CloudLinux components below.

CloudLinux components

CageFS

A virtualized per-user file system encapsulates each customer into a ‘cage’ preventing them from seeing each other files and viewing sensitive information (e.g., system files)

Toggle the sliders to enable CageFS by default for new and/or existing users.

Note

CageFS is a requirement for PHP Selector operation.

LSAPI

It is the fastest and most reliable way to serve PHP pages for Apache web-servers, a drop-in replacement for SuPHP, FCGID, RUID2, and ITK.

LSAPI requires CRIU to operate and we also recommend you to use mod_suexec. You can find details in our documentation.

MySQL Governor

Monitors MySQL usage to throttle abusers, preventing server overload and improving overall performance.

Note

MySQL Governor can be automatically installed only with cPanel/WHM and DirectAdmin - use CLI instructions available here in all other cases.

We recommend you to create a full database backup before the MySQL Governor installation.

Node.js Selector

Allows end users to create Node.js applications and select the specific version of Node.js and other parameters.

Here you can choose versions to be installed and the version to be used as default.

Ruby Selector

Allows end users to select the specific version of Ruby they need.

Here you can choose Ruby versions to be installed.

Python Selector

Allows end users to select the default version of Python and set the required versions for installation.

Here you can choose Python versions to be installed.

PHP Selector

Allows end users to select the specific version of PHP they need, with over 120 PHP extensions to choose from.

Go to LVE Manager settings to set up PHP Selector options and parameters. Read more in the PHP Selector documentation.

Note

CageFS should be enabled for PHP Selector to operate.

When the components to be installed are selected and configured, and installation is started, you will be redirected to the LVE Manager | Dashboard.

Installation process and possible errors

Installation status is displayed throughout the process in the Dashboard. Click Installing to show modules installation state.

All installed modules are displayed on the Dashboard. When installation is completed successfully, you will see the following status.

If you decide to remove failed module or a module to be installed by clicking the (X) button, a confirmation dialog will appear.

After confirming the action, the module will disappear from the list.

If module installation fails, the Installing button changes to Warning and the module indicator will turn red.

  • Click to download the error log.
  • Click to try to install a module again.
  • Click to remove a specific module from the installation queue. The module will be displayed on the Dashboard but will not be installed.

If module auto-installation fails, you will see that the module indicator turns yellow.

In this case, you can download a log for details and try to install the module again.

Wizard fatal error

In case of a fatal error, you will see the following warning.

  • Click to download the error log.
  • Click to try to install module(s) again.
  • Click to cancel installation. The canceled modules will be removed from the installation process.

You can contact our support team for further assistance anytime by submitting a ticket in our helpdesk system.

LVE Manager

cPanel LVE Manager administrator interface allows monitoring and managing limits for hosts end users, managing packages and monitoring statistics.

Administrator credentials allow controlling limits for host users.

Log in as administrator to get access to the following functionality:

  • Dashboard provides a quick overview of statistics and all administrative information for server administrators.
  • Current usage tab - allows monitoring users resource usage at the moment;
  • Users tab with the list of all users allows viewing and managing all the users limits;
  • Statistics tab displays the statistics of resource usage for proper timeframe or proper users;
  • Options tab - allows setting LVE Faults email notifications for users;
  • Packages allows managing packages limits;
  • PHP Selector tab.

For more details, please go to the ImunifyAV documentation.

Notifications color codes LVE Manager 5.3.7-1+

In the LVE Manager UI we use the following color codes for notifications:

  • warning
  • error
  • information
  • success

The following actions are available in the action notifications (error, success)

  • follow a link
  • copy a command
  • copy a whole traceback

The following actions are available in the system notifications (information, warning):

  • follow a link
  • copy a command
  • copy a whole message
  • mark a notification as “Read”
  • snooze a notification
### Dashboard

Note

Available starting from LVE Manager 4.0-26.8

CloudLinux dashboard provides a quick overview of statistics and all administrative information for server administrators.

Go to LVE Manager | Dashboard.

The Cloudlinux Dashboard provides the following information:

  • End Users hitting limits — number of users reaching their limit in any kind of resource. Data is within the last 24 hours.
  • Resellers hitting limits —  number of enrolled Resellers that are reaching their limit in any kind of resource. Data is within the last 24 hours.
  • Node.js Selector block displays the following data:

    • Node.js Selector status (Enabled/Disabled/Not installed) —  displays a current status of the Node.js Selector.

      • To manage Node.js Selector, click Manage. You will be redirected to LVE Manager | Options | Node.js Selector.

      • Click Install to install Node.js Selector, you will be redirected to LVE Manager | Options | Node.js.Selector.

    • Default version — the current default version of Node.js set in your system. Click Manage to change the default version account wide.

    • Applications —  number of installed/all applications for the account.

  • Ruby Selector block displays the following data:

    • Ruby Selector status (Enabled/Disabled/Not installed) — displays a current status of the Ruby Selector.

      • To manage Ruby Selector, click Manage. You will be redirected to LVE Manager | Options | Ruby Selector.

      • Click Install to install Ruby Selector, you will be redirected to LVE Manager | Options | Ruby Selector.

    • Applications — number of installed/all applications for the account.

  • PHP Selector block displays the following data:
    • Default version — the default version of PHP binaries. Click Manage to change the default version, enable or disable PHP Selector, change the list of supported versions, and choose default modules. You will be redirected to LVE Manager | PHP Selector.
      PHP Selector (cPanel) has malfunctions warnings about the most common issues.
  • Python Selector block displays the following data:

    • Python Selector status (Enabled/Disabled/Not installed — displays a current status of the Python Selector.

      • To manage Python Selector, click Manage. You will be redirected to LVE Manager | Options | Python Selector.

      • Click Install to install Python Selector, you will be redirected to LVE Manager | Options | Python Selector.

    • Applications —  number of installed/all applications for the account.

  • Reseller Limits block displays the following data:
    • Reseller Limits status (Enabled/Disabled). To manage Reseller Limits, click Manage. You will be redirected to LVE Manager | Users tab.
    • Reseller’s accounts with Reseller Limits/all —  the number of Reseller accounts with Reseller Limits enabled versus the total number of Reseller accounts.
    • Reseller’s End Users with enabled Reseller Limits/all — the number of end users with Reseller Limits enabled versus all End Users that belong to all resellers.
  • MySQL Governor block displays the following data:
    • MySQL Governor status (Enabled/Disabled/Not installed/Skipped). To manage MySQL Governor, click Manage. You will be redirected to LVE Manager | Options | MySQL Governor Mode of Operation. Click Install to install MySQL Governor.
    • Mode — displays the MySQL Governor mode of operation. Click Manage to change the mode.
      • Single — single LVE is used for all customers that go over their DB limits (deprecated).
      • Off — monitor Only, no DB query limits are applied.
      • All — all queries are run inside user's LVE.
      • Abusers — only queries that go over DB limits are executed inside that user's LVE (this is the default mode).
    • Database version —  displays a current version of MySQL/MariaDB/Percona server installed in the system.
  • CageFS block displays the following data:
    • CageFS status (Enabled/Disabled/Not installed). To manage CageFS, click Manage. You will be redirected to LVE Manager | Options | CageFS. Click Install to install CageFS.
    • Mode displays the current CageFS mode of operation.
    • End users — displays the number of users with CageFS enabled/all.
  • ModLSAPI block displays the following data:
    • Mod_lsapi status (Enabled/Disabled/Not installed). Click Install to install Mod_lsapi.
    • Module version displays the running version of Mod_lsapi.
    • Criu_status displays the status of lsapi_criu:
      • Running —  means that lsapi_criu is working.
      • Stopped —  means that lsapi_criu is not working.
    • Total Domains displays the total number of domains with Mod_lsapi configured as PHP handler.
    • Criu_version displays the running version of lsapi_criu.
    • LSAPI with connection pool.

Note

  • If statistics for server is absent for any reasons, you can update it by pressing the Refresh button. This process can last from 10 seconds to one hour depending on your server's performance, number of users and applications.
  • If statistics collection is turned off it is not displayed. If you wish to get daily statistics for your server, please turn it on by adding cl_statistics_enabled=1 parameter to the /etc/sysconfig/cloudlinux file.
  • Data for the Dashboard is collected once per day. If you want to update data manually, press Refresh. This process can last from 10 seconds to one hour depending on your server's performance, number of users and applications.

Current usage

Choose Current usage tab to monitor users resource usage at the moment displayed in the table.

Current usage table provides the information on the usage of Speed, memory, IO, IOPS, Number of Processes, and Entry Processes.

Resource usage values are being refreshed every 10 seconds which is set in Auto-refresh field. You can refresh the table manually by clicking Refresh now or you can freeze the values by clicking pause button. Usage values will not change until the next manual refresh.

Tick Hide MySQL usage checkbox to hide the information on MySQL usage.

To expand the list of users click on the number above and in the dropdown choose the number of user to be displayed on the page.

Users

Choose Users tab to view the list of all users in the system and manage their limits.

The following filters are available:

  • Manage by
    • End users
    • Resellers
    • Reseller's end users
    • Reseller's end users (no Reseller limit)
  • Show only
    • Ignored users - show users with ignored MySQL Governor.
    • Users with CageFS enabled

Also, you can search user by his Username, domain or LVE ID in the Search field.

Actions

  • Edit limits

    Click in the Actions column to edit limits for a proper user.

    • SPEED
    • PMEM
    • VMEM
    • EP
    • IO
    • IOPS
    • NPROC
    • INODES

    Click Save to apply changes or Cancel to close the pop-up.

  • View history

    Click in the Actions column to view statistics for a proper user.

Group actions for users with enabled CageFS

Note

If CageFS is disabled, group actions are not available. See how you can enable CageFS:

  • View users with enabled CageFS

    To view users with enabled CageFS, click Show only >> Users with CageFS enabled

  • Disable CageFS for several users

    To disable CageFS for several users, do the following.

    • Select a particular user or select all users
    • Click CageFS >> Disable.

Statistics

Choose Statistics tab to view hosts users resource usage statistics.

The following parameters are displayed in the statistics table:

  • CPU usage per user;
  • PMEM usage per user;
  • VMEM usage per user;
  • IO (in Kb/sec per user).

Statistics table can be filtered by:

  • Timeframe - to view the statistics for a proper period;
  • Limit ID - to view a proper limit type usage only;
  • Top LVEs - to view top used limits only;
  • LVE approaching limit - to view the limits that are approaching maximum allocated value;
  • Fault LVE - the limits that have reached the maximum value.

Options

The following sections are available to set the required options:

LVE Faults Email Notifications

The following types of notification are available:

  • Notify Hoster - receive notifications on users and its own LVE faults
  • Notify Reseller - allows reseller receiving notifications on their user's LVE faults
  • Notify Customers - allow host's users receiving notifications on their LVE faults
  • Notify Reseller's customers - allows resller's users receiving notifications on their LVE faults

Faults to include

Tick checkboxes to include required limits to the notifications:

  • SPEED - include SPEED limit fault to the notification
  • IO - include I/O limit fault info to the notification
  • IOPS - include IOPS limit fault info to the notification
  • Memory - include Memory limit fault info to the notification
  • Concurrent connections - include concurrent connections limit fault info to the notification
  • NPROC - include NPROC limit fault info to the notification.

Minimum number of Faults to notify

Set a number of faults required for the notification to be sent for:

  • Hoster and Reseller
  • User

Set the frequency of email notifications sending to:

  • Hoster and Reseller
  • User

Inode limits

Allows to reset inode limits and show/hide end-user inode usage.

Note

Starting from LVE Manager 5.3.7-1 this option is available in cPanel, Plesk, and DirectAdmin. Before it was available only in cPanel.

User interface settings

Allows to manage user interface settings:

  • Hide LVE end user usage statistic - a user will not be able to see his usage statistic in his web interface

    Note

    Starting from LVE Manager 5.3.7-1 this option is available for cPanel, Plesk, and DirectAdmin control panels. Before it was available only in cPanel.

  • Hide Ruby App in web-interface - a user will not be able to see Ruby Selector in his web interface

MySQL Governor settings

Allows to manage MySQL Governor settings.

MySQL Governor Mode of operation

  • Off - monitor Only – not throttle customer's queries, only monitor MySQL usage.
  • Single - single restricted LVE for all restricted customers – all queries for all restricted customers well be sharing the same LVE.
  • Abusers - use LVE for a user to restrict queries (default mode) – if a user goes over the limits, all his queries will execute inside his LVE.
  • All - always run queries inside user's LVE – limits are applied to both PHP & MySQL queries at the same time.

MySQL Governor restrict type mode

  • Period – allows to restrict users for a specified time period
  • Limit (default mode) – allows to restrict/automatically unrestrict users that hit limits/don't hit limits during 'unlimit=time'

Unlimit users automatically in

Allows to unlimit users automatically if they don't hit the limits during the specified number of seconds/minutes/hours/days.

Restricted time periods

User restriction time period for different levels of restriction and the timeout to apply a higher restriction level.

  • Level1
  • Level2
  • Level3
  • Level4
  • Timeout

User maximum connections

The number of simultaneous connections of a restricted user (in the LVE mode).

Path to script

To be triggered when account is restricted.

MySQL Governor restrict-log file URL and format

  • URL – where the log file is placed in the file system
  • Format – log file format: short, medium, long, very long

MySQL Governor error-log file URL and logging level

  • URL – where the log file is placed in the file system
  • Level – logging level: error, debug

Kill slow SELECT queries

  • Kill slow queries – stop running slow select queries
  • URL – log file URL, where killed queries will be saved
  • Timeout – number of seconds while slow request can be finished, otherwise, it will be canceled

Gather data for detailed statistics

Tick if yes.

Log restricted user's queries

Tick if yes.

CageFS

Allows to manage CageFS settings:

  • CageFS - enable/disable CageFS
  • CageFS Skeleton - click to update CageFS skeleton. See: Updating CageFS skeleton
  • New users will be disabled by default in CageFS - toggle to enable/disable new users in CageFS by default.

Node.js

Allows to enable/disable and manage Node.js Selector.

See more:

Python Selector section

Allows to enable/disable and manage Python Selector.

See more:

When you've done with settings, click Save Changes to apply changes.

Packages

Packages tab allows setting the limits for as many users as you need by editing packages of proper limits. Each account belonging to a proper package adheres to those limits.

Note

Limits from the package will not be applied if the package’s owner differs from the owner of the account you’re trying to apply limits to. Default limits will be applied instead.

Choose Packages tab to view and modify:

  • limits for hosts user’s packages (Created by Admin);
  • limits for reseller’s packages (Created by Admin).

To modify package limits click on a pencil icon in Action column in a proper package row. The following limits for this package are available for setting:

  • SPEED in percent (%);
  • Virtual memory (VMEM) (can be set as unlimited by setting 0);
  • Physical memory (PMEM) (can be set as unlimited by setting 0);
  • Concurrent connections (EP);
  • Number of processes (NPROC) (can be set as unlimited by setting 0);
  • IOPS limits;
  • I/O limits (IO) (can be set as unlimited by setting 0);
  • INODES soft;
  • INODES hard.

When limits are set click Save to apply changes or Cancel to close the window.

PHP Selector

Selector tab

Selector tab allows controlling PHP Selector settings.

  • In Selector is section choose Enabled or Disabled from the dropdown list to enable or disable PHP Selector.
  • In Default PHP version choose a proper PHP version or Native from dropdown list to apply.
  • In Hide php extensions for end-user you can enable/disable the ability for end-user to select PHP extensions in his web interface.

Note

Starting from LVE Manager 5.3.7-1 this option is available in cPanel, Plesk, and DirectAdmin. Before it was available only in cPanel.

  • In Supported versions choose required PHP versions to support.

Choose default modules from the list for a proper PHP version or for native.

Note

You can also use PHP Selector CLI

Selector tab additional features cPanel LVE Manager 6.0.1-2

Go to cPanel admin interface → LVE manager → Selector

Selector tab has two sub tabs: Main settings and Domains.

  • Main settings sub tab allows to config general settings for PHP Selector
    • Selector is: allows to enable/disable PHP Selector
    • Default PHP version: allows to set PHP version by default
    • Hide PHP extensions for end-user: allows to hide PHP extensions
    • Hide "My domains" page for end-user: allows to disable such tab for end-user
    • Supported versions: allows to select supported PHP versions
  • Domains sub tab contains the list of User-Domain pairs to visualize which PHP Selector is used by a domain

Admin can filter the list:

If an admin clicks Use PHP selector in the Action table, the PHP version for a domain in MultiPHP Selector is changed to the system default version and php-fpm is disabled. Users' websites will use the version set in CloudLinux PHP Selector (user interface). Group operation also can be used.

PHP Selector troubleshooting cPanel LVE Manager 6.0.1-2

You can see the following errors in the Domains tab.

  1. PHP Selector cannot be activated for this domain. Initialize CageFS in the Options tab first.

Solution

Initialize CageFS in the Options tab (see installation instructions).

  1. PHP Selector cannot be activated for this domain. Enable CageFS for this user in the Users tab first.

Solution

Enable CageFS in the Users tab (see installation instructions).

  • You can enable CageFS for one user by individual slider (for lve 1001 in the picture above)
  • You can enable CageFS for a group of user by the CageFS button (for lve 1002, 1003 in the picture above)
  1. Some PHP related issues need to be resolved in order to enable domain management. Find the list of PHP related issues that prevent domain management above.

Solution

If you cannot see Diagnostic tool notifications, you can restart it. Then you can fix the issues using these instructions.

PHP Selector diagnostic tool and notifications LVE Manager 6.0.1-2

The diagnostic tool allows to catch some issues. You can start diagnostic by clicking Run diagnostic button.

The most popular errors and solutions:

  1. Your PHP Handler does not support CLoudLinux PHP Selector

Solution: install mod_suexec (see instructions here) and then run the following command:

cagefsctl --force-update
  1. Incorrect config file format

Solution: correct the file format via SSH.

  1. Some domains have neither PHP version selected in MultiPHP Manager no system default version or have php-fpm enabled.

Solution: see installation instructions for cPanel users

  1. MultiPHP system default version is not ea-php

Solution: see installation instructions for cPanel users

In the LVE Manager v.6.0.6-1 the diagnostic tool can not catch problems with CageFS. See installation instructions for cPanel users.

Python Selector

Hoster interface allows to enable and disable Python Selector and manage individual Python versions.

Go to LVE Manager → Options Tab → Python Selector.

A list of installed Python versions is displayed. There are several columns in the list.

  • Version — displays Python version.
  • Path — Python package location.
  • Applications — number of applications that use this Python version. Click on an application number to go to the list of applications.
  • Enabled — displays if particular Python version is enabled.
  • Actions — allows to install, delete, and make default a particular Python version.

To display all changes immediately click Refresh.

How to enable/disable Python Selector

To enable Python Selector move a slider to Enable and complete the action by clicking Agree or click Cancel to close the popup. To disable Python Selector move a slider back to Disable.

Note

If you disable Python, all users won't be able to manage their applications

Note

Python Selector icon in end user interface is hidden when Python is disabled.

How to manage Python Selector

In the list of installed Python versions you can enable and disable, install and delete, and set a particular Python version as a default.

Enable and disable particular Python version

To enable particular Python version do the following:

  • Move a disabled slider in the Enabled column for a particular Python version.
  • In the confirmation popup click Agree to save changes or Cancel to close popup.

To disable particular Python version do the following:

  • Move an enabled slider in the Enabled column for a particular Python version.
  • In the confirmation popup click Agree to save changes or Cancel to close popup.

Install and delete particular Python version

To install particular Python version do the following:

  • Click Install button in the Actions column for a particular Python version.
  • In the confirmation popup click Agree to save changes or Cancel to close popup.

To delete particular Python version do the following:

  • Click Bin icon in the Actions column for a particular Python version.
  • In the confirmation popup click Agree to start uninstalling process. Or close popup without changes by clicking Cancel button.

Note

It is impossible:

  • to remove default Python version
  • to remove version with applications
  • to install or remove version if another installation/uninstalling process is running

Make a particular Python version as a default

Note

You can set a particular Python version as a default version in the CloudLinux installation wizard during the first installation.

To make a particular Python version as a default version, do the following:

  • Click Double-Tick icon in the Actions column for a particular Python version.
  • In the confirmation popup click Agree to save changes or Cancel to close popup.

Note

It is impossible to make disabled Python version as a default version

Applications column

To view and operate with the list of domains with Python versions click a number in the Applications column for a particular Python version. A section with a list of Domains for particular Python version will be displayed.

Domains are displayed by three. To load more domains click Load More button.

To change Python version for a particular application do the following:

  • Click Double-Arrow icon in the Actions column in a particular application row. A confirmation popup will be displayed.
  • In the popup choose Python version from a dropdown.
  • Click Change to confirm the action or Cancel to close the popup.
  • To refresh state of applications in current version you can click Refresh.

Note

All packages of the application(s) will be re-installed.

Note

You can also use Python Selector CLI

See also: Python Selector client plugin

Node.js Selector

Hoster interface allows to enable and disable Node.js, and manage individual Node.js versions.

Go to LVE Manager → Options Tab → Node.js Section. A list of installed Node.js versions is displayed. There are several columns in the list.

  • Version — displays Node.js version.
  • Path — Node.js package location.
  • Applications — number of applications that use this Node.js version. Click on a digit to go to the list of applications.
  • Enabled — displays if particular Node.js version is enabled.
  • Actions — allows to install, delete, and make default a particular Node.js version.

To display all changes immediately click Refresh link.

How to enable/disable Node.js

  • To enable Node.js move the slider to Enable.
  • To disable Node.js move the slider back to Disable.

Note

If you disable Node.js, its version for all your applications will not be changed, but you can not add a new application to this version.

Note

Node.js Selector icon in end user interface is hidden when Node.js is disabled.

How to manage Node.js

The list of installed Node.js versions allows to enable and disable, install and delete, and set a particular Node.js version as a default.

Enable and disable particular Node.js version

To enable particular Node.js version do the following:

  • Move a disabled slider in the Enabled column for a particular Node.js version.
  • In the confirmation pop-up click Agree to save changes or Cancel to close pop-up.

To disable particular Node.js version do the following:

  • Move an enabled slider in the Enabled column for a particular Node.js version.
  • In the confirmation pop-up click Agree to save changes or Cancel to close pop-up.

Install and delete particular Node.js version

To install particular Node.js version do the following:

  • Click Install button in the Actions column for a particular Node.js version.
  • In the confirmation pop-up click Agree to save changes or Cancel to close pop-up.

To delete particular Node.js version do the following:

  • Click Bin icon in the Actions column for a particular Node.js version.
  • In the confirmation pop-up click Agree to start uninstall process.
  • Or just close a pop-up without any changes.

Note

It is impossible:

  • to remove default Node.js version;
  • to remove version with applications;
  • to install or remove version if another installation/uninstall process is running.

Make a particular Node.js version as a default

To make a particular Node.js version as a default do the following:

  • Click Double-Tick icon in the Actions column for a particular Node.js version.
  • In the confirmation pop-up click Agree to save changes or Cancel to close pop-up.

Note

It is impossible to make a disabled version default.

Applications column

To view and operate with the list of domains with Node.js versions click on a number in the Applications column for a particular Node.js version. A section with a list of Domains for particular Node.js version will be displayed.

Domains are displayed by three. To load more domains click on Load More button.

To change Node.js version for a particular application do the following:

  • Click Double-Arrow icon in the Actions column in a particular application row. A confirmation pop-up will be displayed.
  • In the pop-up choose Node.js version from a drop-down.
  • Click Change to confirm the action or Cancel to close the pop-up.
  • To refresh state of applications in current version you can click Refresh link.

Note

All packages of the application(s) will be re-installed.

Note

You can also use Node.js Selector CLI

See also: Node.js Selector client plugin

Application error log

Since alt-mod-passenger version 5.3.7-3 we have included support for the PassengerAppLogFile directive. 

Syntax: PassengerAppLogFile path
Default: PassengerAppLogFile path-to-passenger-log-file
Context: virtual host, htaccess

By default, Passenger log messages are all written to the Passenger log file. With this option, you can have the app specific messages logged to a different file in addition. In alt-mod-passenger , you can use it in the context of a virtual host or in the htaccess file.

See also: Node.js Selector CLI tools.

Reseller limits

Hoster interface

Hoster interface allows to monitor and manage limits for hosters’ end users, resellers and resellers’ end users, and also manage packages and monitor statistics.

Hoster credentials allow to control limits for hosters’ end users and resellers. To control reseller end user limits Hoster has to log in as Reseller.

Log in as Hoster to get access to the following functionality.

  • Current Usage tab allows to monitor users and resellers resource usage at the moment.
  • Users tab with the list of all users and resellers allows viewing and managing all the users and resellers limits.
  • Statistics tab displays the statistics of resource usage for particular timeframe or particular user.
  • Options tab allows to set LVE faults email notifications for hoster, users, and resellers.
  • Packages tab allows to manage resellers packages limits;
  • Selector tab allows to control PHP Selector settings.

Current Usage

Choose Current Usage tab to monitor users, resellers and resellers’ end users resource usage at the moment displayed in the table.

Current Usage table provides information on usage of the following:

  • SPEED (All and MySQL)
  • memory (MEM)
  • data throughput (IO) (All and MySQL)
  • read/write operations per second (IOPS)
  • number of processes (PNO)
  • entry processes (EP)

Resource usage values are being refreshed every 10 seconds by default which is set in Auto-refresh field. You can set Auto-refresh time by choosing a value from the drop-down.

You can refresh the table manually by clicking Refresh now or you can freeze the values by clicking pause. Usage values will not change until the next manual refresh. To unfreeze click unpause. The countdown will continue.

Tick Hide MySQL usage to hide the information on MySQL usage.

The list of users can be filtered by Username and Domain.

Hoster can view all types of users:

  • End users
  • Resellers
  • Reseller’s end users
  • Reseller’s end users (no Reseller limit).

But hoster can only manage:

  • End users
  • Resellers
  • Reseller’s end users (no Reseller limit)

To manage Reseller’s end users hoster should login as a reseller.

In the drop-down Show top you can choose the number of user to be displayed on the page.

Users

Choose Users tab to view the list of all users and manage their limits.

To filter the list by user type click Manage and in the drop-down choose:

  • End users - to manage hosts end users only.
  • Resellers - to manage resellers only.
  • Reseller’s end users - to manage resellers’ end users only.
  • Reseller’s end users (no Reseller limits) - to manage resellers’ end users that do not have limits specified by reseller (these limits are specified by the hoster).

To filter the list by Username, Domain, LveID click Filter by and choose the value in the drop-down.

Note

A hoster can view the list of resellers’ end users and their limits, but can not manage resellers’ end users limits (if those are set by reseller).

A hoster can view the limits of all types of users and manage the limits for hosters’ end users and resellers’ end users (only those with Reseller Limits disabled).

  • Tick Show users with CageFS enabled to show users with CageFS file system enabled.
  • Tick Show only ignored users to show users with ignored MySQL Governor.

Actions

Click pencil icon in Actions column to edit limits for a particular user. The following actions are available:

  • Enable/disable CageFS
  • Reset - to reset limits to default values
  • Apply Do not limit to set the limits to unlimited;
  • Setting the limits values:
    • SPEED
    • SPEED MYSQL
    • VMEM
    • PMEM
    • IO
    • MySQL IO
    • IOPS
    • EP
    • NPROC
    • INODES (hard and soft) (for end users and resellers’ end users (with no Reseller Limits), if a hoster has enabled Initial quotas in cPanel settings).

Click Save to save changes or Cancel to close the pop-up.

Click on History symbol to view the history of a particular user resource usage. Choose time frame to view the history for a particular time period.

Statistics

Choose Statistics tab to view end users, resellers and resellers’ end users limits usage statistics.

The following parameters can be displayed in the statistics table:

  • SPEED usage per user;
  • IO usage per user;
  • EP usage per user;
  • VMEM usage per user;
  • PMEM usage per user;
  • NPROC usage per user;
  • IOPS usage per user;
  • MySQL usage per user.

Click Show and select columns from the drop-down to set which parameters should be displayed in the table.

Statistics table can be filtered by:

  • Timeframe - to view the statistics for a particular period;
  • Limit - to view a particular limit type usage only;
  • Top LVEs - to view top used limits only;
  • LVE approaching limit - to view the limits that are approaching maximum provided value;
  • Fault LVE - the limits that have reached the maximum value.

Click Manage to choose type of users to be displayed - End users, Resellers, Resellers’ end users or Resellers’ end users (no Reseller limit) by ticking checkbox in the drop-down.

Click chart symbol in the View column to view the detailed resource usage history for a particular account. Use timeframe drop-down to view the history for a particular period of time.

Options

A hoster can set email notifications for panel administrator, reseller customer, and resellers’ customers in cases of limits faults. Choose Options tab to manage LVE Faults email notifications.

In LVE Faults Email Notifications section tick the required checkboxes to set a type of notification.

  • Notify Panel Administrator - notify hoster when his end users have exceeded minimum number of faults set for particular limits.
  • Notify Reseller - notify reseller when his end users have exceeded minimum number of faults set for particular limits.
  • Notify Customers - notify hosters’ end users when they have exceeded limits.
  • Notify Reseller's customers - notify resellers’ end users when they have exceeded limits.

In Faults to include section tick the checkboxes to include required limits to the notifications. Set the frequency of email notifications sending in Notify …. every.. days/hours/minutes/seconds section.

In Minimum number of Faults to notify section enter the number of faults required for the notification to be sent for Panel Admin & Reseller and User.

  • In Inodes limits section you can reset inode limits to default values and tick Show end-user inode usage.
  • In User interface settings section tick the required checkboxes to apply user interface settings.
  • In MySQL Governor settings section you can customize MySQL Governor.

Packages

Packages tab allows to set the limits for as many users as you need by editing packages of the limits. Each account belonging to a particular package adheres to those limits.

Choose Packages tab to view and modify:

  • limits for user packages (created by hoster);
  • limits for reseller packages (created by hoster);
  • limits for resellers’ end users packages if reseller limits are not set for that reseller (hoster access allows identifying a particular reseller’s end user belonging to a particular reseller (created by reseller)).

To modify package limits click on a pencil symbol in Actions column in a particular package row. The following limits for this package are available for setting:

  • SPEED in percent (%);
  • Virtual memory (VMEM) (can be set as unlimited by setting 0);
  • Physical memory (PMEM) (can be set as unlimited by setting 0);
  • I/O limits (IO) (can be set as unlimited by setting 0);
  • IOPS limits;
  • Concurrent connections (EP);
  • Number of processes (NPROC) (can be set as unlimited by setting 0);
  • INODES (hard and soft) (for end users and resellers’ end users (with no Reseller Limits), if a hoster has enabled Initial quotas in cPanel settings.)

When limits are set click Save to apply changes or Cancel to close the window.

Selector

Selector tab allows to control PHP Selector settings.

  • In Selector is choose Enabled or Disabled from the drop-down to enable or disable PHP Selector.

  • In Default PHP version choose PHP version or Native from the drop-down to apply.

  • In Supported versions choose required PHP versions to support.

Choose default modules from the list for a particular version of PHP or for native.

Reseller Interface

Reseller interface is designed to manage limits for resellers’ end users, to monitor statistics and the history of resource usage and to modify reseller’s end user packages limits.

Log in under a particular reseller credentials to have access to the following functionality:

  • Current Usage tab - allows to monitor resellers’ end users resource usage at the moment;
  • Historical Usage tab - allows to control resellers’ end users resource usage history;
  • Users tab with the list of all resellers’ end users allows to view and manage all the reseller’s end user limits;
  • Statistics tab displays the statistics of resource usage for particular timeframe or particular reseller's end user;
  • Options tab allows to set LVE Faults email notifications.
  • Packages tab allows to manage reseller’s end user packages limits.

Please note that reseller can manage all his end users via Reseller Interface. Reseller cannot manage INODE or MYSQL limits, neither his own nor for his users.

Current Usage tab

Current usage table provides the information on the usage of the following:

  • SPEED (All)
  • memory (MEM)
  • data throughput (IO)(All)
  • read/write operations per second (IOPS)
  • number of processes (PNO)
  • entry processes (EP)

Resource usage data is being refreshed every 10 seconds which is set by default in Auto-refresh field. You can set Auto-refresh time by choosing the value from the drop-down.

You can refresh the table manually by clicking Refresh now or you can freeze the values by clicking pause button.

Usage values will not change until the next manual refresh. To unfreeze click on unpause button. The countdown will continue.

Reseller cannot manage INODE or MYSQL limits. Neither his own, nor for his users.

The bottom line star in the table displays the total reseller resource usage. It means, that all the usage of resellers’ end users and of his own is displayed as a summary for each parameter.

Historical Usage tab

Choose Historical Usage tab to view reseller and resellers’ end users resource usage history and faults. The list of users can be filtered by Timeframe.

When reseller’s end user reaches the limits set by hoster for the reseller, this will be displayed on the chart.

Note

In this case reseller’s end user would not necessarily reaches his limits set by the reseller. These faults are not displayed on the chart.

On the Historical Usage page the reseller is also able to see the list of Top 5 Reseller’s end users (based on resource usage, for the same period as charts/overall usage). Click History in the Actions column to view resource usage statistics for particular user.

Click LVE Statistics on the top of the Top 5 list to go to the Statistics page to view or manage the rest of users.

Users tab

Choose Users tab to view and manage the list of all resellers’ end users and resource usage limits provided for them. The following limits are available for the resellers’ end users:

  • SPEED
  • PMEM
  • IO
  • IOPS
  • EP
  • NPROC

You can filter the list by Username, Domain, LVE ID.

Tick Show only ignored users to display only users with MySQL Governor disabled.

Actions column

Click on a pencil icon in Actions column to edit limits for a particular user. The following actions are available:

  • Click Reset to reset limits to default values.
  • Click Apply for Do not limit to set unlimited resources to a user.
  • Set values for PEED, PMEM, IO, IOPS, EP, and NPROC and click Save to save changes or Cancel to close the window.

Statistics tab

Choose Statistics tab to view resource usage limits statistics.

Statistics table can be filtered by Timeframe, Limit, Top LVEs, LVE approaching limit, Fault LVE.

The following parameters are displayed:

  • SPEED per user;
  • PMEM usage per user;
  • IO usage per user;
  • EP usage per user;
  • NPROC usage per user;
  • IOPS usage per user.

Use Charts in the View column to view detailed resource usage charts for a particular period of time.

For example, 7 days period chart.

Options tab

Choose Options tab to set user email notifications for resellers’ end users.

In LVE Faults email notifications section tick appropriate checkboxes to set the required type of notification.

  • Notify me on users faults - notify reseller when his users have exceeded limits.
  • Notify Customers - notify resellers’ end users when they have exceeded limits.
  • Notify me when I hit my limits - notify reseller when overall resource usage limits are reached.

In Faults to include section tick checkboxes to include particular limits to email notifications.

In Minimum number of Faults to notify section enter the number of faults required for the notification to be sent for reseller and customer. You can also set the reseller notification frequency.

Set the frequency of sending the reseller email notifications in Notify Reseller Every ... days/hours/minutes/seconds section.

Click Save Changes to apply changes.

Packages tab

Choose Packages tab to view and modify limits for reseller’s packages.

Click pencil icon in a package row to set the following limits for a package:

  • SPEED limit;
  • Physical memory (PMEM) (can be set as unlimited by setting 0);
  • I/O limits;
  • IOPS limits;
  • Concurrent connections (EP) limits.

When limits are set click Save to apply changes.

Client plugins

Resource Usage client plugin

Client resource usage plugin for cPanel, Plesk, and DirectAdmin allows host’s end users to view and monitor resource usage.

Go to your control panel and click CPU and concurrent connection usage.

Here you can see three tabs:

  • Dashboard: displays the general condition of your site. If your site is limited, this displays on the Dashboard.
  • Current usage: here you can find full information on the resource usage displayed in charts and tables.
  • Snapshot: server snapshots with processes list and database and HTTP queries.

Dashboard

Go to the Dashboard tab to see the general condition of your site. If your site is limited, you can see this on the Dashboard with the resource you are limited over. To see detailed information about resource usage, click Details.

If your site is not limited, you will see the plain Dashboard.

Current Usage

Go to the Current Usage tab to see the detailed information about resource usage on your server.

Note

It's possible to add the normalized_user_cpu = N value to the /etc/sysconfig/cloudlinux file. So you can see for example CPU Usage X/200 (%) in the scenario where a user's LVE CPU limit is 200%. If the value is equal to Y, CPU Usage cannot get greater than 100%.

Current Usage table

The Current Usage table displays resource usage.

Warning

Inodes usage is displayed if it is enabled and Inodes limits are set for the user. cPanel only.

  • Description: resource name
  • Usage: resource usage value
  • Limit: resource usage limit
  • Fault: number of faults

Filters

You can filter charts and the Usage table by timeframe and time unit (day, hour, minute).

Charts

The following resources are displayed in charts:

  • CPU
  • Virtual Memory
  • Physical Memory
  • Input/Output
  • Io operations
  • Entry Processes
  • Processes

All charts have the color legend:

  • Green — average resource usage
  • Red — limit set for this parameter
  • Blue — database
  • Green-cyan — faults (limit violations)

You can also see the Faults chart with all faults for all resources.

Usage

The Usage table displays information on each resource usage sorted by timeframe and time unit.

  • From-To: period
  • A: average
  • L: limit
  • F: faults

Use controls below the table to navigate through it.

Snapshot

Go to the Snapshot tab to see server snapshots with processes list and database and HTTP queries.

You can choose a date and a snapshot to display in the table.

Server processes snapshots

In case when a CloudLinux user hits LVE limits, appropriate faults are generated and lvestats package generates server processes snapshot. Snapshot is a list of running applications and a list of running MySQL queries right after the faults happened.

Snapshots allow users to investigate the reason of account hitting its limits. Several snapshots are generated for each incident. An incident is a state when faults are generated in a close time period. The time period is configurable. By default, if faults are generated in 300 seconds time period, we consider them as a single incident.

The snapshot configuration options are available in

/etc/sysconfig/lvestats.config/SnapshotSaver.cfg
  • period_between_incidents = 300 by default, time in seconds
  • snapshots_per_minute = 2 by default, maximum number of snapshots per minute
  • max_snapshots_per_incident = 10 by default, maximum number of snapshots for an incident

To access Snapshots you can also use lve-read-snapshot utility.

Note

The list of processes in a snapshot is close but not similar to the real processes list when faults were generated. It happens because of delay when the faults are happened and the snapshot is taken by the system.

The list of MySQL queries is an output of a query:

SELECT command, time, info FROM information_schema.processlist

WHERE user = '%username';

Process list

Displays information on processes in the selected snapshot.

  • PID: process ID
  • CMD: what command was run
  • CPU: CPU usage
  • MEM: memory usage

Database queries (cPanel only)

Displays information on database queries in the selected snapshot.

HTTP queries

Displays information on HTTP queries in the selected snapshot.

Python Selector client plugin

Note

Python Selector icon in end user interface is hidden when Python is disabled

End User interface allows end users to setup and manage Python for their web applications.

Go to cPanel → Software Section → Setup Python App.

Web Applications page is displayed.

There are several columns in the list:

  • App URI — application URI including the domain.
  • App Root Directory — application root directory relative to user's home.
  • Status — started/stopped — displays if an application is running or not and version of the application.
  • Actions — allows to migrate, start, restart, stop, edit, and remove a particular application.

How to manage an application

Create application

  1. Click Create Application to create an application. The Create Application tab opens.

  2. Specify the following:

    • Python version — select from the dropdown (required);
    • Application root — physical address to your application on a server that corresponds with its URI (required);
    • Application URL — HTTP/HTTPS link to your application (optional);
    • Application startup file — the file where WSGI callable object is located. It is required for application to run. Default is passenger_wsgi.py;
    • Application Entry point — WSGI callable object for your application (optional). Default is application;
    • Passenger log file — starting from LVE Manager 5.1.0-2 you can set paths to Passenger logs for Python applications via UI (or using cloudlinux-selector utility).

  3. Optionally, add environment variable. To do so, click Add Variable and specify variable name and value, then click the Done or Cancel to close an adding form.

To delete or edit environment variable, click Bin or Pencil for the required variable.

Start application

To start a stopped application do the following:

  • Click Start in the Actions column in a stopped application row.
  • When an action is completed a Start changes to Stop.

Stop application

To stop a started application do the following:

  • Click Stop icon in the Actions column in a started application row.
  • When an action is completed a Stop changes to Start.

Restart application

To restart a started application do the following:

  • Click Restart in the Actions column in a started application row. A current row is blocked and when a process is completed it will be unblocked.

Remove application

To remove application do the following:

  • Click Bin in the Actions column in a particular application row.
  • In the confirmation popup click Agree to start removing or Cancel to close the popup.
  • When an action is completed an application will be removed from the Web Applications table and a confirmation popup will be displayed.

Edit application

To edit application do the following:

  • Click the Pencil in the Actions column in a particular application row. A particular application tab opens.

The following actions are available:

  • Restart application — click Restart.
  • Stop application — click Stop App.
  • Remove application — click Destroy and confirm the action in a popup.
  • Change Python version — choose Python version from a dropdown.
  • Change Application root — specify in a field a physical address to the application on a server that corresponds with its URI.
  • Change Application URL — specify in a field an HTTP/HTTPS link to the application.
  • Open Application URL — click the Open.
  • Change Application startup file — specify as NAME.py file.
  • Change Application Entry point — specify WSGI callable object for your application.
  • Passenger log file — starting from LVE Manager 5.1.0-2 you can set paths to Passenger logs for Python applications via UI (or using cloudlinux-selector utility).
  • Run pip install command — click Run pip install to install the package(s) described in the configuration file.
  • Add Configuration files — click Add and specify all required information.
  • Edit available configuration file — click Edit, the file opens in a new popup.
  • Remove available configuration file from the list — click Remove and confirm the action or click Cancel to close the popup.
  • Add Environment variables — click Add Variable and specify a name and a value.

Click Save to save all changes or Cancel to close the tab.

Migrate application

For details see How to migrate an application to the new Python Selector

Note

You can also use Python Selector CLI

Node.js Selector client plugin

Note

Node.js Selector icon in end user interface is hidden when Node.js is disabled.

End User interface allows end users to setup and manage Node.js for their web applications.
Go to cPanel → Software Section → Setup Node.js App.

Web Applications page is displayed.

There are several columns in the list.

  • App URI — application URI including the domain.
  • App Root Directory — application root directory relative to user's home.
  • Mode — can be production or development.
  • Status — started/stopped — displays if an application is running or not and version of application.
  • Actions — allows to start, restart, stop, edit, and remove a particular application.

How to manage application

Start application

To start a stopped application do the following:

  • Click Start icon in the Actions column in a stopped application row.
  • When an action is completed a Start icon changes to Stop icon.

Stop application

To stop a started application do the following:

  • Click Stop icon in the Actions column in a started application row.
  • When an action is completed a Stop icon changes to Start icon.

Restart application

To restart started application do the following:

  • Click Restart icon in the Actions column in a started application row. A current row is blocked and when a process is completed it will be unblocked.

Remove application

To remove application do the following:

  • Click Bin icon in the Actions column in a particular application row.
  • In the confirmation pop-up click Agree to start removing or Cancel to close pop-up.
  • When an action is completed an application will be removed from the Web Applications table and a confirmation pop-up will be displayed.

Edit application

To edit application do the following:

  • Click Pencil icon in the Actions column in a particular application row. A particular application tab opens.

The following actions are available:

  • Restart application — click Restart button.
  • Stop Node.js — click Stop Node.js button.
  • Run JavaScript script — click Run JS Script button to run a command specified in the Scripts section of the package.json file. Specify the name of the script to run plus any parameters then click Ok .
  • Remove application — click Delete button and confirm the action in a pop-up.
  • Change Node.js version — choose Node.js version from a drop-down.
  • Change Application mode — choose application mode from a drop-down. Available modes are Production and Development .
  • Application root — specify in a field a physical address to the application on a server that corresponds with its URI.
  • Application URL — specify in a field an HTTP/HTTPS link to the application.
  • Application startup file — specify as NAME.js file .
  • Passenger log file — starting from LVE Manager 5.1.0-2 you can set paths to Passenger logs for Node.js applications via UI (or using cloudlinux-selector utility).
  • Run npm install command — click Run npm install button to install the package(s) described in the package.json file.
  • Add Environment variables — click Add Variable and specify a name and a value.

Note

You can also use Node.js Selector CLI

Ruby Selector client plugin

End user interface allows end users to setup and manage Ruby for their web applications.

Go to cPanel → Software Section → Setup Ruby App.

Setup Ruby application page is displayed.

Here you can do the following:

  • Setup a new application.
  • View/edit/restart/remove the existing application.

PHP Selector client plugin

End user interface allows end users to select and manage PHP extensions and options for the particular PHP version.

Go to cPanel → Software Section → Select PHP Version.

PHP Extensions page opens.

Here you can choose extensions for the particular PHP version, the current PHP version and reset to default.

To manage PHP options, click Switch to PHP options.

  • allow_url_fopen. Allows PHP file functions to retrieve data from remote locations over FTP or HTTP. This option is a great security risk, thus do not turn it on without necessity.
  • display_errors. Determines whether errors should be printed to the screen as part of the output or if they should not be shown to a user.
  • error_reporting. The error reporting level.
  • file_uploads. Allows uploading files over HTTP.
  • include_path. The list of directories where scripts look for files (similar to system's PATH variable). To separate directories, use a colon (:) For example: .:/dir/inc:/usr/lib/php
  • log_errors. Tells whether to log errors. By default, errors are logged in the server's error log. Use the error_log directive to specify the path to your own log file.
  • mail.force_extra_parameters. Additional parameters for the mail() function used to send mail. For example, to use your custom Sendmail configuration: -C /dir/conf.cf
  • max_execution_time. The maximum time in seconds a script is allowed to run before it is terminated.
  • max_input_time. The maximum time in seconds a script is allowed to parse input data.
  • memory_limit. The maximum amount of memory in bytes a script is allowed to allocate. Set the value to -1 to have no memory limit (not recommended). Use shortcuts for byte values: K (kilo), M (mega), and G (giga). For example, 128M.
  • open_basedir. The list of directories used to limit the files that can be opened by PHP. If the file is outside the specified directories, PHP scripts will refuse to open it. To separate directories, use a colon. For example: /dir/upload:/usr/tmp.
  • post_max_size. The maximum size in bytes of data that can be posted with the POST method. Typically, should be larger than upload_max_filesize and smaller than memory_limit. Use shortcuts for byte values: K (kilo), M (mega), and G (giga). For example, 16M.
  • session.save_path. The directory where PHP writes session data (files). For example: /dir/tmp
  • short_open_tag. Allows the short form of the PHP open tag.
  • upload_max_filesize. The maximum size in bytes of an uploaded file. Use shortcuts for byte values: K (kilo), M (mega), and G (giga). For example, 128M.

PHP Selector. My Domains tab cPanel LVE Manager 6.0.1-2

The My Domains tab contains a list of user’s domains to visualize which PHP Selector is used by domain.

A user can configure a domain to use CloudLinux PHP Selector.

  1. Click Use PHP Selector

  1. Set a version in PHP Selector

Note

If php-fpm is enabled for a domain the only administrator can set it to disable.

LVE Manager options

You can change LVE Manager settings for a server manually via cPanel/WHM or, if you have many servers, you can change LVE Manager settings for them in the config file.

Changing settings manually

  • Log in to cPanel, go to WHM, choose CloudLinux and click Options.
  • Change settings.

Changing settings in the config file

You can modify the following options in the config file /var/cpanel/cpanel.config directly for example via Puppet.
lve_hideextensions Hides (when =1) range of php extensions for user in Select PHP version
lve_hideuserstat Hides (when =1) LVE statistics in cPanel Stats Bar (UI)
lve_showinodeusage Displays (when =1) used inodes in cPanel (UI)
lve_hide_selector Turns off UI PHP Selector (Select PHP Version option)
lve_enablerubyapp Displays (when =1) Ruby Selector in user’s interface (UI)

Note

It is not allowed to change lve_enablepythonapp option in the config file directly.

You can use cloudlinux-selector utility to change lve_enablepythonapp option:

cloudlinux-selector set --json --interpreter=python --selector-status=enabled

Or you can change it via WHM -> LVE Manager -> Options -> Python Selector -> Python

After modifying the config files directly, you should execute the following command to apply changes:

/usr/share/l.v.e-manager/utils/dynamicui.py --sync-conf=all

LVE plugins branding

Note

Requires LVE Manager 2.0-33+

It is possible to apply branding to the LVE Plugins in cPanel end users’ interface. To brand the cPanel end users' interface please do the following:

  • Create a script that will patch LVE Manager files (with branding data, for example, image and logo) after every update of lvemanager rpm package;

  • Locate this script in /usr/share/l.v.e-manager/branding_script;

  • Make this script executable by running the command:

chmod a+x /usr/share/l.v.e-manager/branding_script

When done, the branding script will be executed while every update of lvemanager package and all branding changes will be applied in the end user’s interface.

Note

Modifying the LVE Manager WHM plugin (/usr/local/cpanel/whostmgr/docroot/cgi/CloudLinux.cgi) via branding_script is not allowed.

User message for PHP version

Since version 1.0-4 LVE Manager acquired a feature of adding user messages to PHP versions*. To add a message, you should create a file in /opt/alt/phpXX/name_modifier with a message that you want to be shown to a user.

For example, if you need to add the following message Don't use this PHP version to PHP version 4.4, you should create the following file:

/opt/alt/php44/name_modifier:

echo 'Don`t use this php version' > /opt/alt/php44/name_modifier

As a result, LVE Manager will automatically pick up this message and will show it in web-interface to administrator (see Figure 1.1 for cPanel, Figure 1.2 for DirectAdmin) and to user (see Figure 2.1 for cPanel, Figure 2.2 for DirectAdmin). You can add messages to other PHP versions this way as well.
Figure 1.1 cPanel LVE Manager (administrator)
Figure 1.2 DirectAdmin LVE Manager (administrator)
Figure 2.1 cPanel LVE Manager (user)
Figure 2.2 DirectAdmin LVE Manager (user)

Note

*For cPanel and DirectAdmin only.

inodes

Note

Supported on cPanel, Plesk, and DirectAdmin control panels

LVE Manager inodes limits extension allows setting inode limits for the customers. An inode is a data structure on a file system used to keep information about a file or a folder. The number of inodes indicates the number of files and folders an account has. inodes limits work on the level of disk quota , and will be enabled on /home partition only.

LVE Manager allows to set soft and hard IO limit.

  • Hard limit prevents a user from writing data to disk.

  • Soft limit can be exceeded for a period of time. The grace period can be set using: edquota -t .

  • You can set inodes limits using LVE Manager , the same way you would set any other LVE Limits:

Note

We do not collect statistical information on the inodes like we do for other LVE limits.

The limits can be set on the level of individual account or package:

Sometimes disk quota breaks, so do inodes limits. You can reset them through the Options tab of LVE Manager:

The same can be achieved using cloudlinux-config CLI utility

End users can monitor their inodes usage through cPanel only (not available on Plesk and DirectAdmin):

End user can also see the usage inside resource usage menu.

Control panel integration guide

Here you will find the instructions and common techniques used to integrate your software with CloudLinux.

Detecting and working with CloudLinux

Detecting if system is running CloudLinux/CloudLinux kernel:

$ uname -r|grep lve

If you get an output, it means the system is running CloudLinux kernel. CloudLinux kernels have lve in its name, like: 2.6.32-458.18.1.lve1.2.44.el6.x86_64

Alternatively you can check for the presence of /proc/lve/list file.

Check if CageFS is enabled (as root ):

$ /usr/sbin/cagefsctl --cagefs-status

Check if CageFS is enabled for a particular user (as root ):

$ /usr/sbin/cagefsctl --user-status _USER_NAME_

Check if you are inside CageFS:

Check for the presence of /var/.cagefs/.cagefs.token file - if present, it means that you are inside CageFS.

Displaying CPU, memory & IO limits

Most control panels choose to display CloudLinux usage & limits to end customers. To simplify that, we lve-stats exports a file that can be easily read and processed by a control panel to display the necessary information.

The information is located in the /var/lve/info file. This information is updated every 5 minutes, and contains default limits (first line), as well as usage and limits for all customers. If a customer is not present in the file, it means that customer is not active (no scripts were executed recently for the customer), and a customer has default limits (so you can display no usage, and default limits in the control panel for that customer.

The data is stored in a form of one line per customer, with coma separated values.
0 user id
1 entry processes
2 entry processes limit
3 CPU
4 CPU limit
5 Virtual Memory
6 Virtual Memory Limit
7 Number of virtual memory faults
8 Number of entry processes faults
9 Physical Memory Limit
10 Physical Memory
11 Number of Physical memory faults
12 Number of processes limit
13 Number of processes
14 Number of processes fault
15 Reserved
16 IO Usage
17 IO Limit

With LVE version 4 (CloudLinux lve0.x) only the first 9 parameters are available. You can check the the version by reading the first byte of /proc/lve/list.

In the version 6 all 15 parameters should be available.

There are only 2 LVE versions currently used in production. Future versions might add more fields, but will not alter order of existing fields.

Memory is defined in 4KB pages (so, 1024 would mean 1024 4KB pages, or 4MB).

IO is defined as KB/s.

CPU is defined as % of total number of cores on a server.

cPanel LVE Extension

Note

LVE Manager 1.0-9.8+

cPanel LVE Extension allows to control LVE limits for packages via cPanel hosting packages control interface and via cPanel WHM API . It simplifies integration with existing billing systems for cPanel (like WHMCS for example).

Add Package Extension

To add LVE Settings to standard cPanel package, go to Packages | Add a Package.

Note

You can find the information on how to add a package in official cPanel documentation on the link: https://documentation.cpanel.net/display/ALD/Add+a+Package

Tick LVE Settings in the bottom of the page to open LVE Settings form.

You can specify the following options:

Note

Your changes to LVE Settings will appear in the system after a little while.
Speed Settings Maximum CPU usage for an account. Must be in the range 1 - 100 (but obligatory > 0 ) if old format is used; use % or Mhz\Ghz to set CPU limit as speed; Type DEFAULT to use default value.
Memory Settings Pmem - Maximum physical memory usage for an account. Vmem - Maximum virtual memory usage for an account. Must be a positive number. Postfix allowed only in KGMT. Type DEFAULT to use default value. Type 0 for unlimited resource.
Max entry proc Settings Maximum number of entry processes (concurrent connections) for an account. Must be a positive number. Type DEFAULT to use default value. Type 0 for unlimited resource.
Nproc Settings Maximum number of processes usage for an account. Must be a positive number. Type DEFAULT to use default value. Type 0 for unlimited resource.
IO Settings Maximum I/O (input/output) usage speed for an account. Is measured in Kb/s. Must be a positive number. Type DEFAULT to use default value. Type 0 for unlimited resource.
IOPS Settings Maximum IOPS (input/output operations per second) usage for an account. Must be a positive number. Type DEFAULT to use default value. Type 0 to unlimited resource.

Click Add to apply your changes.

Edit Package Extensions

You can edit limits in any convenient for you way - in Edit a Package section, in the LVE Manager or even via WHM API.

Edit a Package

To edit package extensions, go to Packages | Edit a Package. Choose a package from the Package list and click Edit.

LVE Manager

To edit package extensions, go to LVE Manager | Server Configuration | CloudLinux LVE Manager | Packages and click pencil (edit) icon.

WHM API

To learn how to work with package extensions limits using WHM API, please read the official cPanel documentation: https://documentation.cpanel.net/display/SDK/Guide+to+Package+Extensions+-+Data+Behavior+and+Changes

Edit this page
We are Cloudlinux
2020. CloudLinux Inc
How to
Getting started
Contact support
Blog