diff --git a/docs/.vuepress/config-client/documents.ts b/docs/.vuepress/config-client/documents.ts index 8f9805fe3..f284fbad7 100644 --- a/docs/.vuepress/config-client/documents.ts +++ b/docs/.vuepress/config-client/documents.ts @@ -2,18 +2,13 @@ export default [ { title: "Introduction to Cloudlinux OS", description: "Introduction to CloudLinux OS editions and their description.", - link: "/introduction/", + link: "/introduction/cloudlinux-os-editions/", }, { title: "CloudLinux OS", - description: "Optimizes shared hosting environments by enhancing stability, security, and performance through user isolation and efficient resource management. Featuring tools like LVE resource limits, CageFS, and multiple language selectors, it empowers hosting providers to offer superior services. The CloudLinux OS Shared Pro edition further extends functionality with even more valuable features.", + description: "Optimizes shared hosting environments by enhancing stability, security, and performance through user isolation and efficient resource management. Featuring tools like LVE resource limits, CageFS, and multiple language selectors, it empowers hosting providers to offer superior services.", link: "/cloudlinuxos/cloudlinux_installation/", }, - { - title: "Apache2Nginx (BETA)", - description: "Apache2Nginx sets up Nginx hosting with .htaccess support.", - link: "/cloudlinuxos/apache2nginx/", - }, { title: "AccelerateWP", description: "AccelerateWP carries a suite of optimization features that can be enabled and automatically configured for the end user's site.", @@ -24,16 +19,6 @@ export default [ description: "CLN is a CloudLinux Network designed to easily manage your licenses of CloudLinux products and services by means of a user-friendly interface.", link: "/cln/introduction/", }, - { - title: "CloudLinux Solo", - description: "CloudLinux OS Solo is designed for VPS or dedicated servers with a single hosting account for any number of websites.", - link: "/solo/introduction/", - }, - { - title: "CloudLinux OS Admin", - description: "CloudLinux OS Admin is designed for shared hosting providers and allows flawless migration of big shared hosting customers to individual VPS with the same CloudLinux features as on shared hosting.", - link: "/admin/description/", - }, { title: "CloudLinux Subsystem For Ubuntu", description: "CloudLinux subsystem on Ubuntu is a scope of deb-packages that allows using CloudLinux features on Ubuntu OS.", diff --git a/docs/.vuepress/config-client/sidebar.ts b/docs/.vuepress/config-client/sidebar.ts index cfbb6a651..80b6fe9ce 100644 --- a/docs/.vuepress/config-client/sidebar.ts +++ b/docs/.vuepress/config-client/sidebar.ts @@ -12,31 +12,9 @@ export default { { collapsable: false, children: [ - "/introduction/" - ] - }, - ], - '/admin/': [ - { - collapsable: false, - children: [ - "/admin/description/", - "/admin/installation/", - "/admin/components/", - "/admin/faq/" - ] - }, - ], - '/solo/': [ - { - collapsable: false, - children: [ - "/solo/introduction/", - "/solo/installation/", - "/solo/activation/", - "/solo/administration/", - "/solo/manager/", - "/solo/faq/" + "/introduction/cloudlinux-os-editions/", + "/introduction/solo/", + "/introduction/admin/" ] }, ], diff --git a/docs/.vuepress/routes.json b/docs/.vuepress/routes.json index 42ec86c7f..0aab424e1 100644 --- a/docs/.vuepress/routes.json +++ b/docs/.vuepress/routes.json @@ -54,5 +54,13 @@ "/shared-pro/": "/cloudlinuxos/shared-pro/", "/cloudlinuxos-pro/introduction/":"/cloudlinuxos/shared-pro/#introduction", "/shared-pro/accelerate-wp": "/cloudlinuxos/shared-pro/#acceleratewp", - "/cloudlinuxos/shared-pro/accelerate-wp/": "/cloudlinuxos/shared-pro/#acceleratewp" + "/cloudlinuxos/shared-pro/accelerate-wp/": "/cloudlinuxos/shared-pro/#acceleratewp", + "/solo/introduction/":"/introduction/solo/", + "/solo/activation/":"/introduction/solo/#license-activation", + "/solo/faq/":"/introduction/solo/#faq", + "/admin/description/":"/introduction/admin/", + "/admin/installation/":"/introduction/admin/#licensing", + "/admin/components/":"/introduction/admin/#components", + "/admin/faq/":"/introduction/admin/#faq" + } diff --git a/docs/admin/.DS_Store b/docs/admin/.DS_Store deleted file mode 100644 index 5008ddfcf..000000000 Binary files a/docs/admin/.DS_Store and /dev/null differ diff --git a/docs/admin/components/README.md b/docs/admin/components/README.md deleted file mode 100644 index 82fdaeebf..000000000 --- a/docs/admin/components/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Components - -CloudLinux OS Admin is very close to the regular CloudLinux Legacy (Shared) edition, which means that -99% of components described in this documentations are available for CloudLinux OS Admin. - -The exclusions are: - - - [MySQL Governor](/cloudlinuxos/control_panel_integration/#mysql-governor) is not available - - [X-Ray](/cloudlinuxos/shared-pro/#x-ray) is available like with CloudLinux Shared Pro - - [Accelerate WP](/cloudlinuxos/shared-pro/#acceleratewp) is available like with CloudLinux Shared Pro - -The rest of the components are similar to CloudLinux OS Legacy (Shared). - diff --git a/docs/admin/description/README.md b/docs/admin/description/README.md deleted file mode 100644 index 8fcf93e72..000000000 --- a/docs/admin/description/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Description - -CloudLinux OS Admin is designed for shared hosting providers who want to flawlessly migrate their -big shared hosting customer to individual VPS with same CloudLinux features as on Shared hosting. -At the same time you will be able to separate such a user's websites if necessary and isolate them -with CageFS for efficient and extra security. -Also it may be suitable for a little server with less than 5 customers on it. - -Most of the features of CloudLinux OS Legacy (Shared) are available in this edition, with a small differences: - -- lve limits are set to unlimited by default (can be changed in CloudLinux Manager at any time) -- MySQL Governor is not available in this edition -- the license itself does not allow more than 5 users to be hosted on server. - -:::tip Note -The CloudLinux OS Admin plan does not include the MySQL Governor -::: diff --git a/docs/admin/faq/README.md b/docs/admin/faq/README.md deleted file mode 100644 index 2057f7291..000000000 --- a/docs/admin/faq/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# FAQ - -**Q**: *Is it possible to convert my existing CloudLinux OS Legacy (Shared) server into CloudLinux OS Admin?*
-**A**: Yes, for CloudLinux 8 and higher it is possible to convert CloudLinux OS Legacy (Shared) to any other edition like CloudLinux OS Admin, Solo, Shared Pro. For CloudLinux 7 it is only possible to convert it into Shared Pro. - -**Q**: *Is Centralized Monitoring supported on CloudLinux OS Admin?*
-**A**: No, Centralized Monitoring only works with CloudLinux OS Shared Pro license. diff --git a/docs/admin/installation/README.md b/docs/admin/installation/README.md deleted file mode 100644 index 18bd38526..000000000 --- a/docs/admin/installation/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Installation - -CloudLinux OS Admin installation process is the same as for CloudLinux Legacy (Shared), please forward to [installation guide](/cloudlinuxos/cloudlinux_installation) for detailed instructions. The only difference is to purchase a CloudLinux OS Admin license from [cln.cloudlinux.com](https://cln.cloudlinux.com). - -:::tip Note -The CloudLinux OS Admin can be installed and compatible only with AlmaLinux OS 8+. -::: - - -## Switch license - -You can convert your existing CloudLinux OS Solo installation to CloudLinux OS Admin. - -1. Obtain new key from [CLN](https://cln.cloudlinux.com) -2. Run `rhnreg_ks --force --activationkey=` - -You can pass `--migrate-silently` argument to skip confirmation. diff --git a/docs/cloudlinuxos/cloudlinux_installation/README.md b/docs/cloudlinuxos/cloudlinux_installation/README.md index b2fec6ada..1a235f05d 100644 --- a/docs/cloudlinuxos/cloudlinux_installation/README.md +++ b/docs/cloudlinuxos/cloudlinux_installation/README.md @@ -36,7 +36,9 @@ There are some incompatible devices with **CL6**: With RHEL8 (**CloudLinux OS 8/CloudLinux OS 7 Hybrid**), some devices are no longer supported. You can check the entire list here: [Hardware enablement considerations in adopting RHEL 8](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/considerations_in_adopting_rhel_8/hardware-enablement_considerations-in-adopting-rhel-8#removed-hardware-support_hardware-enablement) -## Software Compatibility +## Software Compatibility + +CloudLinux OS is designed to maintain full binary compatibility with CentOS and Red Hat Enterprise Linux (RHEL). This means that any software, applications, or scripts that run on CentOS or RHEL can run on CloudLinux OS without modification. The operating system ensures broad compatibility with the vast ecosystem of Linux software, providing a seamless and stable environment for hosting providers and users transitioning from other enterprise Linux distributions. This compatibility extends to package management, system libraries, and core functionalities, making CloudLinux OS a reliable drop-in replacement that supports the same software stack as its counterparts. ### ZFS @@ -48,14 +50,15 @@ CloudLinux 8+ provides limited support for ZFS, to the same degree as other RHEL 1. Because ZFS is known to have some lag in adapting to kernel changes, we consider it the customer's responsibility to test the upgradeability of the environment to the most recent kernels and ZFS versions before upgrading the entire fleet. 1. Most CloudLinux features, like CageFS, should work fine with ZFS-backed mount points, and if not, we will try our best to provide fixes according to severity and demand -CloudLinux features known to not work with ZFS: +:::tip CloudLinux features known to not work with ZFS: -1. LVE IO Limits (as well as generic cgroups limits) don't work because the ZFS data path bypasses some of the kernel's internals. See related upstream tickets [1](https://github.com/canonical/lxd/issues/7627#issuecomment-671107839), [2](https://github.com/openzfs/zfs/issues/4275#issuecomment-1137332006), [3](https://github.com/openzfs/zfs/issues/1952#issuecomment-148471131). There is also an [ongoing attempt](https://github.com/openzfs/zfs/pull/16205) to implement per-dataset IO limits on the ZFS side. +LVE IO Limits (as well as generic cgroups limits) don't work because the ZFS data path bypasses some of the kernel's internals. See related upstream tickets [1](https://github.com/canonical/lxd/issues/7627#issuecomment-671107839), [2](https://github.com/openzfs/zfs/issues/4275#issuecomment-1137332006), [3](https://github.com/openzfs/zfs/issues/1952#issuecomment-148471131). There is also an [ongoing attempt](https://github.com/openzfs/zfs/pull/16205) to implement per-dataset IO limits on the ZFS side. +::: ## Getting License -You will need a valid activation key - trial or paid - to be able to use your CloudLinux OS Solo server. +You will need a valid activation key - trial or paid - to be able to use your CloudLinux OS server. ### Getting Trial License @@ -78,7 +81,6 @@ To get the activation key: You will get a key that looks like: `12314-d34463a182fede4f4d7e140f1841bcf2`. - ## Converting existing servers Sometimes it is required to convert already existing servers with **`CentOS`** or **`AlmaLinux`** and make them **`CloudLinux OS`**. @@ -97,13 +99,11 @@ Currently supported OS for conversion: * AlmaLinux OS 8, AlmaLinux OS 9 * RockyLinux (installation only, no uninstall option) - :::warning Unsupported OS for conversion: * CentOS 8 * CentOS Stream ::: - Supported control panels: * cPanel ([Documentation](https://docs.cpanel.net/installation-guide/system-requirements-cloudlinux/)) * Plesk @@ -112,6 +112,9 @@ Supported control panels: * InterWorx ([Documentation](https://appendix.interworx.com/current/nodeworx/plugins/install-use-cloudlinux-plugin-interworx.html)) * Webuzo ([Documentation](https://webuzo.com/docs/installing-webuzo/install-cloudlinux-os/)) +:::warning Warning: +CloudLinux 9 does not support Plesk. +::: :::warning Other control panels: Control panels not mentioned in the list of supported panels have native integration or integration done by the developer of the panel. diff --git a/docs/introduction/admin/README.md b/docs/introduction/admin/README.md new file mode 100644 index 000000000..cc5065af8 --- /dev/null +++ b/docs/introduction/admin/README.md @@ -0,0 +1,59 @@ +# CloudLinux OS Admin Introduction + +## Description + +CloudLinux OS Admin is designed for shared hosting providers who want to flawlessly migrate their +big shared hosting customer to individual VPS with same CloudLinux features as on Shared hosting. +At the same time you will be able to separate such a user's websites if necessary and isolate them +with CageFS for efficient and extra security. +Also it may be suitable for a little server with less than 5 customers on it. + +Most of the features of CloudLinux OS Legacy (Shared) are available in this edition, with a small differences: + +- lve limits are set to unlimited by default (can be changed in CloudLinux Manager at any time) +- MySQL Governor is not available in this edition +- the license itself does not allow more than 5 users to be hosted on server. + +:::tip Note +The CloudLinux OS Admin plan does not include the MySQL Governor +::: + +## Components + +CloudLinux OS Admin is very close to the regular CloudLinux Legacy (Shared) edition, which means that +99% of components described in this documentations are available for CloudLinux OS Admin. + +The exclusions are: + + - [MySQL Governor](/cloudlinuxos/control_panel_integration/#mysql-governor) is not available + - [X-Ray](/cloudlinuxos/shared-pro/#x-ray) is available like with CloudLinux Shared Pro + - [Accelerate WP](/cloudlinuxos/shared-pro/#acceleratewp) is available like with CloudLinux Shared Pro + +The rest of the components are similar to CloudLinux OS Legacy (Shared). + +## Licensing + +### Installation process + +CloudLinux OS Admin installation process is the same as for other editions – use the [installation guide](/cloudlinuxos/cloudlinux_installation) for detailed instructions. The only difference is to purchase a CloudLinux OS Admin license from [cln.cloudlinux.com](https://cln.cloudlinux.com). + +:::tip Note +The CloudLinux OS Admin can be installed and compatible only with AlmaLinux OS 8+. +::: + +### Switch license + +You can convert your existing CloudLinux OS Solo installation to CloudLinux OS Admin. + +1. Obtain new key from [CLN](https://cln.cloudlinux.com) +2. Run `rhnreg_ks --force --activationkey=` + +You can pass `--migrate-silently` argument to skip confirmation. + +## FAQ + +**Q**: *Is it possible to convert my existing CloudLinux OS Legacy (Shared) server into CloudLinux OS Admin?*
+**A**: Yes, for CloudLinux 8 and higher it is possible to convert CloudLinux OS Legacy (Shared) to any other edition like CloudLinux OS Admin, Solo, Shared Pro. For CloudLinux 7 it is only possible to convert it into Shared Pro. + +**Q**: *Is Centralized Monitoring supported on CloudLinux OS Admin?*
+**A**: No, Centralized Monitoring only works with CloudLinux OS Shared Pro license. \ No newline at end of file diff --git a/docs/introduction/README.md b/docs/introduction/cloudlinux-os-editions/README.md similarity index 59% rename from docs/introduction/README.md rename to docs/introduction/cloudlinux-os-editions/README.md index 63e99c864..27b211b69 100644 --- a/docs/introduction/README.md +++ b/docs/introduction/cloudlinux-os-editions/README.md @@ -1,6 +1,11 @@ -# Introduction +# Introduction to CloudLinux OS -[[toc]] +* [CloudLinux OS editions](/introduction/cloudlinux-os-editions/) + * [CloudLinux OS Solo](/introduction/solo/) + * [CloudLinux OS Admin](/introduction/admin/) + * [CloudLinux OS Shared (Pro)](/cloudlinuxos/shared-pro/) +* [CloudLinux OS components](/introduction/cloudlinux-os-editions/#cloudlinux-os-components) +* [CloudLinux OS life cycle](/introduction/cloudlinux-os-editions/#cloudlinux-os-life-cycle) ## CloudLinux OS editions @@ -29,41 +34,7 @@ \** LVE limits are disabled by default. -\*** Python/Node.js/Ruby Selectors are available only for cPanel, DirectAdmin servers, and servers with custom panel with own integration. - -### CloudLinux OS Solo -CloudLinux OS Solo is designed for installation on VPS or VDS servers. -This edition has major differences compared to all others, so please make sure to carefully examine the feature table to see if it is suitable for you -[here](/introduction/). - - -### CloudLinux OS Admin - -CloudLinux OS Admin is designed for shared hosting providers who want to flawlessly migrate their -big shared hosting customer to individual VPS with same CloudLinux features as on Shared hosting. -At the same time you will be able to separate such a user's websites if necessary and isolate them -with CageFS for efficient extra security. -Also it may be suitable for a small server with less than 5 customers on it. - -Most of the features of CloudLinux OS Legacy (Shared) are available in this edition, with a small differences: - -- lve limits are set to unlimited by default (can be changed in CloudLinux Manager at any time) -- MySQL Governor is not available in this edition -- the license itself does not allow more than 5 users to be hosted on server. - -### CloudLinux OS Shared (Pro) - -CloudLinux OS Shared Pro is designed for shared hosting providers. -It isolates each customer into a separate “Lightweight Virtualized Environment” (LVE), -which allocates and limits server resources, like memory, CPU and the number of simultaneous connections, -for each web hosting tenant. This ensures that tenants cannot jeopardize the stability of your servers, -causing all sites to slow down or even come to a halt. CloudLinux OS Shared Pro also “cages” tenants from one another -to avoid security breaches. This way, unstable scripts or malware are not able to sprawl across your customer sites, -causing severe harm. - -Purchasing CloudLinux OS Shared Pro license extends your CloudLinux OS Legacy (Shared) -functionality with even more useful [features](/shared-pro/introduction/). - +\*** Python/Node.js/Ruby Selectors are available only for cPanel, DirectAdmin servers, and servers with custom panel with own integration. ## CloudLinux OS components @@ -148,22 +119,6 @@ and allows to collect the usage data. [See more](/cloudlinuxos/cloudlinux_os_components/#lve-stats-2). -## CloudLinux 9 - -| CloudLinux 9 version | Editions | Hosting Panels | Virtuozzo Support | -|----------------------------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------|-------------------| -| CloudLinux 9 Beta | CloudLinux Legacy (Shared) CloudLinux Shared Pro | - Non-panel
- Custom panel integration
- [DirectAdmin](https://blog.cloudlinux.com/announcing-support-for-cloudlinux-9-with-directadmin) | No | -| [CloudLinux 9.2](https://blog.cloudlinux.com/cloudlinux-os-9.2-is-now-available-for-non-panel-and-custom-panel-installations) | CloudLinux Legacy (Shared) CloudLinux Shared Pro | - Non-panel
- Custom panel integration
- cPanel with experimental key
- DirectAdmin | No | -| [CloudLinux 9.3](https://blog.cloudlinux.com/cloudlinux-os-9-introducing-the-latest-9.3-version-now-accessible-for-non-panel-custom-panel-and-cpanel-users-from-version-11.116.0.1-onwards)
[CloudLinux 9.4](https://blog.cloudlinux.com/introducing-cloudlinux-os-9.4-stable-release) | CloudLinux Legacy (Shared)
CloudLinux Shared Pro
CloudLinux Solo
CloudLinux Admin | - Non-panel
- Custom panel integration
- cPanel >= 11.116.0.1
- DirectAdmin | No | - -:::tip Note! -Starting from v11.116.0.1, cPanel is fully integrated with CloudLinux 9 (9.2+), and the flag `--experimental-os=almalinux-9.2` no longer necessary. -::: - -:::tip Note! -If you have a server with cPanel + CloudLinux already installed via the experimental flag `--experimental-os=almalinux-9.2`, as described here, it is highly recommended to reinstall the server from scratch to avoid unexpected behavior. -::: - ## CloudLinux OS life cycle CloudLinux OS follows the life cycle policy of RHEL. @@ -177,4 +132,4 @@ Currently, the following versions are available and supported: |CloudLinux OS 6 | Feb 1, 2011 | Nov 30, 2020 ([ELS until June 30, 2024](/cln/billing/#cloudlinux-os-6-extended-lifecycle-support)) | |CloudLinux OS 7 | Apr 1, 2015 | Jun 30, 2024 (ELS until June 30, 2025) | |CloudLinux OS 8 | Mar 17, 2020 | May 31, 2029 | -|CloudLinux OS 9 | Jan 17, 2023 | May 31, 2032 | +|CloudLinux OS 9 | Jan 17, 2023 | May 31, 2032 | \ No newline at end of file diff --git a/docs/introduction/solo/README.md b/docs/introduction/solo/README.md new file mode 100644 index 000000000..f5ee78044 --- /dev/null +++ b/docs/introduction/solo/README.md @@ -0,0 +1,245 @@ +# CloudLinux OS Solo Introduction + +## What is CloudLinux OS Solo + +CloudLinux OS Solo is designed for installation on VPS or dedicated servers with a single hosting account for any number of websites. + +Unlike [CloudLinux OS Legacy (Shared)](/introduction/), this edition is not designed for Shared Hosting usage and it does not include any [LVE-related](/cloudlinuxos/lve_manager/) features. + +We provide the CloudLinux OS Solo with pre-installed features, but for grafical interface, please install a control panel on your server. + +:::warning +Currently supported OS version is CloudLinux OS Solo 8+ only. Therefore, for now, there is no possibility to use CloudLinux OS Solo on servers with OS version 6 and 7. +Please refer to the [currently supported OS versions](/introduction/#cloudlinux-os-solo-lifecycle). +::: + +### Benefits + +We believe that this distribution will be useful for you if: +1. as a site owner you have different performance issues with websites hosted. + CloudLinux OS Solo provides a set of tools for website monitoring and performance tracking out-of-box; +2. as a service provider you sell VPS servers and some of your customers require OS with extensive features + for better security, support, and performance. + +In any case we provide you [24/7 professional support](https://cloudlinux.zendesk.com/) +to resolve any issues related to CloudLinux OS, its unique components and kernel. + +### CloudLinux OS Solo Features + +We've pre-installed a couple of useful features in our distribution. The complete list of supported features is available in the [table above](/solo/introduction/#cloudlinux-os-editions-comparison). + +* **CloudLinux Manager** + + CloudLinux Manager is a plugin which allows you to control all the + CloudLinux settings from an easy-to-use web UI integrated into your control panel. + + The sub-modules you can find in CloudLinux Manager are Website Monitoring tool, PHP Slow Site analyzer, and X-Ray. + + [See more](/solo/manager/). + +* **Website Monitoring tool** + + Website Monitoring tool is a tool that allows you to track your websites uptime + and receive notifications about problems with access. + + Website Monitoring tool can gather and display information regarding the slowest websites on the server, + notify by emails about errors happened on websites and send you daily website performance reports. + + [See more](/solo/manager/#website-monitoring-tool). + +* **PHP Slow Site analyzer** + + PHP Slow Site analyzer (SSA) is a tool that generates daily reports for the server administrator + with information about the top N slow PHP-based URLs for all domains. + + The Slow Site analyzer tracks all PHP-based requests and selects slow ones by specific rules. + + [See more](/solo/manager/#php-slow-site-analyzer). + +* **X-Ray** + + X-Ray is a tool developed for website performance monitoring and performance issues detection. + + X-Ray can gather and visualize information about top slowest system functions, external requests, + software modules and database queries of the client’s PHP website. + + [See more](/solo/manager/#x-ray). + +### How can I try your distribution before paying for it? + +We provide trial licenses for 30 days. You can get your trial key in two ways: + +1. On the CloudLinux OS Solo main page, see [CloudLinux OS Solo](https://lp.cloudlinux.com/cloudlinux-os-solo). +2. In the CloudLinux Manager plugin, see the [Getting trial key](/solo/manager/#activation) section. + + +The trial key must be entered during installation. + +### CloudLinux OS Solo Lifecycle + +CloudLinux OS Solo has the same life cycle policy as RHEL. +Using a supported operating system is critical to maintaining a stable server environment. + +Currently, the following version are supported: + +|Operating System | Release Date| End of Life and Support| +|-|--|-| +|CloudLinux OS Solo 8 | Jun 1, 2021 | May 31, 2029 | + +### What's next + +1. The [Installation](/cloudlinuxos/installation) section contains information about how to install this OS. +2. The [landing page](https://lp.cloudlinux.com/cloudlinux-os-solo) contains the instructions about how to buy license or get trial. + +## Licensing + +### Getting license + +You will need a trial or payed activation key to be able to use your CloudLinux OS Solo server. +Please [refer to this page](https://lp.cloudlinux.com/cloudlinux-os-solo) to find information on how to get activation key. + +The activation key looks like: `CLSOLO-d34463a182fede4f4d7e140f1841bcf2` + +Use it to [activate your system](/solo/activation/#license-activation) +or to [convert server to CloudLinux](/solo/installation/#converting-existing-servers) server. + +:::warning +The CloudLinux OS Solo activation key is used ONLY for registration CloudLinux OS Solo 8. +Trying use it for registration CloudLinux OS Legacy (Shared) 6/7/8 or converting from CentOS 6/7/ 8 to CloudLinux OS Legacy 6/7/8 cause errors. +::: + +:::tip Note +Activation gives you access to the [CloudLinux Manager](/solo/manager/#cloudLinux_manager) features and system updates. +::: + +### License activation + +There are several ways to register your server with CloudLinux Network: + +using the activation key by following commands: + +``` +yum install rhn-setup --enablerepo=cloudlinux-base +/usr/sbin/rhnreg_ks --activationkey= +``` + +using IP-based licensing: + +``` +yum install rhn-setup --enablerepo=cloudlinux-base +/usr/sbin/clnreg_ks +``` + +## FAQ + +[[toc]] + +### What is the difference between CloudLinux Solo and CloudLinux OS Legacy (Shared)? + +CloudLinux OS Solo is not designed for shared hosting usage and it does not include any [LVE-related](/cloudlinuxos/lve_manager/) features. + +CloudLinux OS Solo provides a set of tools for website monitoring and performance tracking out-of-box. [Read more](/solo/manager/). + +### Can I convert CloudLinux Solo to CloudLinux Legacy? + +Yes, you can follow the [instruction](/cloudlinuxos/cloudlinux_installation/#switch-license). + +### Is the CloudLinux OS Solo paid/unpaid? + +You should purchase a license to use CloudLinux OS Solo. + +### Where can I get the latest ISO of CloudLinux OS Solo? + +You can download the latest ISO and use it to install CloudLinux OS Solo on your server using [this link](https://repo.cloudlinux.com/cloudlinux/8/iso/x86_64/). + +### How can I get the CloudLinux OS Solo trial license? + +Please refer to [this page](https://cloudlinux.com/trial) to find information on how to get the trial license and the activation key. + +### How many servers can I use with the trial license? + +The number of servers is unlimited. + +### What control panel can be used with CloudLinux OS Solo? + +For the current implementation, we recommend using cPanel Solo, Plesk, DirectAdmin or Webuzo. + +### How can I get support for my CloudLinux OS Solo servers? + +Please feel free to ask your questions [here](https://cloudlinux.zendesk.com/hc/en-us/). + +### Can I convert to CloudLinux OS Solo from another OS? + +You can convert CentOS/AlmaLinux OS to CloudLinux OS Solo. Please refer to [this instruction](/solo/installation/#converting-existing-servers). + +### What is the Website Monitoring tool intended for? + +The Website Monitoring tool is intended for monitoring the domain main page generation time and errors occurring when requesting the main page (the main tab). + +* The administrator can get the list of the slowest requests during 24 hours (the PHP Slow Site analyzer tab). +* The administrator can receive the daily reports with the list of the slow requests. +* The administrator receives instant emails if the domain main page is unavailable. + +You can read more about the Website Monitoring tool [here](/solo/manager/#website-monitoring-tool). + +### What is the X-Ray tool intended for? + +The X-ray tool is intended for deep analysis of slow request cause. The X-ray tool can provide information about software modules and plugins execution time, database queries, system functions and external requests execution time. + +It can be used by the administrator and by the user. + +You can read more about the X-Ray tool [here](/solo/manager/#x-ray). + +### Will the Website Monitoring Tool (WMT) work with the LiteSpeed and Nginx web servers? + +Yes, they will. + +### Why I don't receive emails from the Website Monitoring tool? + +Please verify your cPanel firewall settings. + +### Can I use other CloudLinux products (Imunify360, KernelCare) with CloudLinux OS Solo? + +Yes, it is possible. + +### Can I register my CloudLinux OS Legacy (Shared) 6/7/8 with CloudLinux OS Solo trial key? + +No, you cannot. + +### Can I convert CentOS 6,7 to CloudLinux OS Solo 8+ using the cldeploy script? + +No, you cannot. Only CentOS 8/AlmaLinux 8+ can be converted. + +### Does CloudLinux OS Solo work with LiteSpeed? + +No, it does not. We are still implementing this feature, so it will be available in the next CloudLinux OS Solo releases. + +### What is the process of upgrading if the customer adds more users to the server and will have to upgrade? (i.e., upgrading from CloudLinux OS Solo to CloudLinux OS Legacy (Shared)) + +Follow the edition switching [procedure](/cloudlinuxos/cloudlinux_installation/#switch-license). + +### How to set up PHP-fpm handler for the domain? + +Since the PHP-fpm handler is required to use AccelerateWP, you may need to configure it manually. + +These are configuration steps: + +1. Ensure the PHP-fpm package for the current PHP version is installed or install it. + + * **Manual installation** + + Run the following command: + ``` + yum -y install ea-phpXY-php-fpm + ``` + Where `XY` - is required PHP version, for instance `ea-php74-php-fpm` + + * **Via MultiPHP Manager** + + ![](/images/solo/faq/InstallationViaMultiPHPManager.webp) + + +2. Enable PHP-fpm handler for domain via MultiPHP Manager + +![](/images/solo/faq/EnablePHPFpm.webp) + diff --git a/docs/solo/.DS_Store b/docs/solo/.DS_Store deleted file mode 100644 index 8c847eb1b..000000000 Binary files a/docs/solo/.DS_Store and /dev/null differ diff --git a/docs/solo/activation/README.md b/docs/solo/activation/README.md deleted file mode 100644 index 4ede6aeb4..000000000 --- a/docs/solo/activation/README.md +++ /dev/null @@ -1,41 +0,0 @@ - -# Licensing - -[[toc]] - -## Getting license - -You will need a trial or payed activation key to be able to use your CloudLinux OS Solo server. -Please [refer to this page](https://lp.cloudlinux.com/cloudlinux-os-solo) to find information on how to get activation key. - -The activation key looks like: `CLSOLO-d34463a182fede4f4d7e140f1841bcf2` - -Use it to [activate your system](/solo/activation/#license-activation) -or to [convert server to CloudLinux](/solo/installation/#converting-existing-servers) server. - -:::warning -The CloudLinux OS Solo activation key is used ONLY for registration CloudLinux OS Solo 8. -Trying use it for registration CloudLinux OS Legacy (Shared) 6/7/8 or converting from CentOS 6/7/ 8 to CloudLinux OS Legacy 6/7/8 cause errors. -::: - -:::tip Note -Activation gives you access to the [CloudLinux Manager](/solo/manager/#cloudLinux_manager) features and system updates. -::: - -## License activation - -There are several ways to register your server with CloudLinux Network: - -using the activation key by following commands: - -``` -yum install rhn-setup --enablerepo=cloudlinux-base -/usr/sbin/rhnreg_ks --activationkey= -``` - -using IP-based licensing: - -``` -yum install rhn-setup --enablerepo=cloudlinux-base -/usr/sbin/clnreg_ks -``` \ No newline at end of file diff --git a/docs/solo/administration/README.md b/docs/solo/administration/README.md deleted file mode 100644 index 43f6f21f3..000000000 --- a/docs/solo/administration/README.md +++ /dev/null @@ -1,72 +0,0 @@ - -# Administration - -This section contains information that will be useful for server -administrators that want to automatize server configuration or do some -unusual things which are not available in the WEB UI. - -[[toc]] - -## OS detection - -To get information about the current CloudLinux OS edition, you can run the following command: - - cldetect --detect-edition - -A response for CloudLinux OS Solo will be like follows: - - CloudLinux OS Solo - -## Best practices for virtualization templates - -While we recommend and support using of the usual [CloudLinux Solo](/solo/installation/) installation process, -it may require more time than is necessary for Virtual Private Server (VPS) and Virtual Machine (VM) hosts. - -Instead, you can provision VPS or VM systems with a templated environment. - -### Create a minimal installation for templating - -Before you begin, you need the activation key that you will use for CloudLinux OS Solo installation. -Follow the [installation](/solo/installation/) guide and create the minimal working CloudLinus OS Solo environment. -Use activation key to register your instance and get full access to repositories and run the -`yum update` command to fetch recent changes. - -### Manage templates - -#### Provisioning - -We recommend using tools like `ansible` to add packages and tune server configuration. -You are free to install any control panels, tune settings and configure the default CloudLinux tools. - -#### Finalize your template - -If you install the control panel in your customized template, -please run following commands once installation is done. - - /usr/bin/package_reinstaller.py - -Commands above will fix hooks and control panel plugins after installation. - -Before you save your customized template, it is required to remove license files: - - rm -f /etc/sysconfig/rhn/jwt.token* - rm -f /etc/sysconfig/rhn/systemid* - rm -f /etc/sysconfig/rhn/cl-rollout* - -#### Updating templates - -:::tip -We strongly recommend recreating templates at least once a month to keep images -fresh and up-to-date with the recent CloudLinux OS Solo repositories. -::: - -There are two ways of templates update: - -1. Recreate them from scratch each time (recommended). -2. Boot customized template, register instance again and run the `yum update` command. - Don't forget to remove license keys from the template as described - in [Finalize your template](./#finalize-your-template). - -#### Next steps - -Save the modified environment as the template and publish it for your clients. diff --git a/docs/solo/faq/README.md b/docs/solo/faq/README.md deleted file mode 100644 index b734bbdab..000000000 --- a/docs/solo/faq/README.md +++ /dev/null @@ -1,114 +0,0 @@ - -# FAQ - -[[toc]] - -### What is the difference between CloudLinux Solo and CloudLinux OS Legacy (Shared)? - -CloudLinux OS Solo is not designed for shared hosting usage and it does not include any [LVE-related](/cloudlinuxos/lve_manager/) features. - -CloudLinux OS Solo provides a set of tools for website monitoring and performance tracking out-of-box. [Read more](/solo/manager/). - -### Can I convert CloudLinux Solo to CloudLinux Legacy? - -Yes, you can follow the [instruction](/cloudlinuxos/cloudlinux_installation/#switch-license). - -### Is the CloudLinux OS Solo paid/unpaid? - -You should purchase a license to use CloudLinux OS Solo. - -### Where can I get the latest ISO of CloudLinux OS Solo? - -You can download the latest ISO and use it to install CloudLinux OS Solo on your server using [this link](https://repo.cloudlinux.com/cloudlinux/8/iso/x86_64/). - -### How can I get the CloudLinux OS Solo trial license? - -Please refer to [this page](https://cloudlinux.com/trial) to find information on how to get the trial license and the activation key. - -### How many servers can I use with the trial license? - -The number of servers is unlimited. - -### What control panel can be used with CloudLinux OS Solo? - -For the current implementation, we recommend using cPanel Solo, Plesk, DirectAdmin or Webuzo. - -### How can I get support for my CloudLinux OS Solo servers? - -Please feel free to ask your questions [here](https://cloudlinux.zendesk.com/hc/en-us/). - -### Can I convert to CloudLinux OS Solo from another OS? - -You can convert CentOS/AlmaLinux OS to CloudLinux OS Solo. Please refer to [this instruction](/solo/installation/#converting-existing-servers). - -### What is the Website Monitoring tool intended for? - -The Website Monitoring tool is intended for monitoring the domain main page generation time and errors occurring when requesting the main page (the main tab). - -* The administrator can get the list of the slowest requests during 24 hours (the PHP Slow Site analyzer tab). -* The administrator can receive the daily reports with the list of the slow requests. -* The administrator receives instant emails if the domain main page is unavailable. - -You can read more about the Website Monitoring tool [here](/solo/manager/#website-monitoring-tool). - -### What is the X-Ray tool intended for? - -The X-ray tool is intended for deep analysis of slow request cause. The X-ray tool can provide information about software modules and plugins execution time, database queries, system functions and external requests execution time. - -It can be used by the administrator and by the user. - -You can read more about the X-Ray tool [here](/solo/manager/#x-ray). - -### Will the Website Monitoring Tool (WMT) work with the LiteSpeed and Nginx web servers? - -Yes, they will. - -### Why I don't receive emails from the Website Monitoring tool? - -Please verify your cPanel firewall settings. - -### Can I use other CloudLinux products (Imunify360, KernelCare) with CloudLinux OS Solo? - -Yes, it is possible. - -### Can I register my CloudLinux OS Legacy (Shared) 6/7/8 with CloudLinux OS Solo trial key? - -No, you cannot. - -### Can I convert CentOS 6,7 to CloudLinux OS Solo 8+ using the cldeploy script? - -No, you cannot. Only CentOS 8/AlmaLinux 8+ can be converted. - -### Does CloudLinux OS Solo work with LiteSpeed? - -No, it does not. We are still implementing this feature, so it will be available in the next CloudLinux OS Solo releases. - -### What is the process of upgrading if the customer adds more users to the server and will have to upgrade? (i.e., upgrading from CloudLinux OS Solo to CloudLinux OS Legacy (Shared)) - -Follow the edition switching [procedure](/cloudlinuxos/cloudlinux_installation/#switch-license). - -### How to set up PHP-fpm handler for the domain? - -Since the PHP-fpm handler is required to use AccelerateWP, you may need to configure it manually. - -These are configuration steps: - -1. Ensure the PHP-fpm package for the current PHP version is installed or install it. - - * **Manual installation** - - Run the following command: - ``` - yum -y install ea-phpXY-php-fpm - ``` - Where `XY` - is required PHP version, for instance `ea-php74-php-fpm` - - * **Via MultiPHP Manager** - - ![](/images/solo/faq/InstallationViaMultiPHPManager.webp) - - -2. Enable PHP-fpm handler for domain via MultiPHP Manager - -![](/images/solo/faq/EnablePHPFpm.webp) - diff --git a/docs/solo/installation/README.md b/docs/solo/installation/README.md deleted file mode 100644 index 2e3dbc19e..000000000 --- a/docs/solo/installation/README.md +++ /dev/null @@ -1,318 +0,0 @@ -# Installation - -[[toc]] - - -## Hardware compatibility - -CloudLinux OS Solo supports all the hardware supported by RHEL/CentOS, with few exceptions. -Exceptions are usually hardware that requires binary drivers, and that doesn't have any open-source alternatives. - -:::warning -CloudLinux OS Solo does not support ARM-based CPUs (e.g. Graviton) -::: - - -With RHEL 8 (**CloudLinux 8**), some devices are no longer supported. -You can [check the entire list here](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/considerations_in_adopting_rhel_8/hardware-enablement_considerations-in-adopting-rhel-8#removed-hardware-support_hardware-enablement). - - -## Fresh installation - -### Downloading installation media - -You can download the latest ISO and use it to install -CloudLinux OS Solo on your server using [this link](https://repo.cloudlinux.com/cloudlinux/8/iso/x86_64/). - -There are multiple ISO types available: - -* `CloudLinux-*-boot.iso` - this ISO is made specifically for network installation and does not contain any packages inside. -* `CloudLinux-*-dvd1.iso` - this one contains all packages from the network installation repository, - so you can set up any possible configuration without network access. -* `CloudLinux-*-minimal.iso` - this one contains only a minimal set of packages to set up a light server without GUI and Development tools. - -:::tip Note -Once you install a server from the ISO, make sure you [register your system](/cloudlinuxos/cloudlinux_installation/#license-activation) -and then run the `yum update` command to get all recent updates. -::: - - -### Installing in the Graphical User Interface - -The graphical installation interface is the preferred method of manually installing CloudLinux OS Solo. -It allows you to have full control over all available settings, including disk partitioning and storage configuration. - -The graphical mode is used by default when you boot the system from the local media. - -#### Language selection - -The first screen displayed is the language selection page. - -![Welcome page screenshot](/images/solo/installation/welcome_page.webp) - -First, find your preferred language in the left column and then select locale in the right one. -The selected language will be used during installation and also as a default language of the installed system. - -After you select your language and locale, click `Continue` to confirm your selection -and proceed to the [Installation Summary](/solo/installation/#installation-summary). - -#### Installation summary - -The Installation summary screen is the main dashboard of your installation parameters. -Most of the options which can be configured during the installation can be accessed from here. - -![Welcome page screenshot](/images/solo/installation/installation_summary.webp) - -The summary screen displays links to other configuration screens, those links can be in -several different states, which are graphically indicated: - -- Grayed-out link means that the installer is currently updating this section. - Please wait a little before accessing this section. - -- A warning symbol next to an icon means that a screen requires your attention before you start the installation. - -- Links without a warning symbol mean that the screen does not require your attention. - You can still change your settings in these screens, but it is not required to start the installation. - -#### Installation source - -The first thing that you should define is where the system will be installed from. -There are basically two options: - -- ISO file -- On the network - -#### On the network source - -Use this option to download packages to be installed from a network location. -This is the preferred way as you automatically receive all critical bug fixes that may affect installation. - -:::tip Note -Most likely your network is not configured by default, -so you can see the URL configuration field greyed out, like on the screenshot below. Please refer to the Network Configuration screen first to set up a network connection. -::: - -![Unavailable network source](/images/solo/installation/installation_source_gray_network.webp) - -The correct installation URL for CloudLinux OS Solo is - -```text -https://repo.cloudlinux.com/cloudlinux/8/BaseOS/x86_64/kickstart/ -``` - -Type in the installation URL in the corresponding field, configure the proxy if needed and press the `Done` button. - -![](/images/solo/installation/installation_source_network_address.webp) - - -#### ISO file source - -This option is primarily used as an alternative when you don't have an internet connection on a target server. -It is only available if you downloaded Minimal or DVD ISO which contains some bundled packages in. - -![](/images/solo/installation/installation_iso_source.webp) - -Tick the `ISO file` checkbox and press the `Done` button. - -#### Next steps - -After clicking `Done`, you will be redirected to the [Installation Summary](/solo/installation/#installation-summary) screen -where [Installation source](/solo/installation/#installation-source) and [Software Selection](/solo/installation/#software-selection) links -will be greyed and the `Downloading package metadata` message wll be shown. - -![](/images/solo/installation/installation_source_gray_working.webp) - -Please hold on while that message disappears and proceed to the [Software Selection](/solo/installation/#software-selection) section. - -![](/images/solo/installation/installation_source_gray_done.webp) - - -#### Software Selection - -The Software Selection screen allows you to choose a Base Environment and Add-ons. -These options control which software packages will be installed on your system during the installation process. - -This screen is only available if Installation Source is properly configured and only after the installer -has downloaded package metadata from the source. - -It is not possible to select specific packages during a manual installation, you can only select pre-defined environments and add-ons. - -To install CloudLinux OS Solo, first, choose the `CloudLinux OS Solo (minimal)` environment on the left of the screen. - -:::warning Warning -All other environments are used to install [CloudLinux OS](http://docs.cloudlinux.com/), so make sure you choose `CloudLinux OS Solo (minimal)`. -::: - -Only one environment can be chosen, even if more are available. - -Then, on the right side of the screen, select one or more add-ons which you want to install by ticking the check boxes next to each add-on. - -#### Final preparations - -Installation is almost done, all you need to do is to [configure your installation target](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/installation_guide/sect-disk-partitioning-setup-x86) -using the `Installation Destination` menu and create your [Root Password](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/installation_guide/sect-configuration-progress-menu-x86#sect-account-configuration-x86). - -Doing that, the `Begin installation` button becomes blue, so click it. - -![](/images/solo/installation/installation_available.webp) - -After this point, the installation process actually starts and changes are being made to your selected disks. -It is not possible to go back to the Installation Summary and change any settings configured there; -if you need to do so, you must wait for the installation process to finish, reboot your system, log in and change your settings -on the installed system. - -The bottom of the screen shows a progress bar and a message informing you of the current progress of the installation. -When the installation finishes, you can press the Finish installation button -to reboot your computer and log in to your newly installed system. - -:::warning Warning -Before you finish the installation and reboot, either remove the media -which you used to start the installation, or make sure that your system tries to boot -from the hard drive before trying removable media. Otherwise, your computer will start the installer again instead of the installed system. -::: - -![](/images/solo/installation/installation_done.webp) - -#### Next steps - -Reboot your system, login and check EULA which is located in the `/usr/share/cloudlinux-release/EULA`. - -Next, [activate your installation](/solo/manager/#activation) in order to get updates. - - -## Converting existing servers - -:::warning -Only AlmaLinux/Rocky Linux 8+ can be converted to CloudLinux OS Solo. -::: - -Sometimes it is required to convert already existing `AlmaLinux` or `Rocky Linux` servers to `CloudLinux OS Solo`. - -It is easy to convert your existing installation by cldeploy script. The process takes a few minutes and replaces just a handful of RPMs. - -:::warning -Unlike [Fresh installation](/solo/installation/#fresh-installation), converting requires a CloudLinux OS Solo license. -Please refer to the [guide](/solo/activation/) to get the activation key. -::: - -### Downloading and running conversion script - -If you already have an activation key, run the following commands: - -``` -yum install wget -y -wget https://repo.cloudlinux.com/cloudlinux/sources/cln/cldeploy -bash cldeploy -k ACTIVATION_KEY -``` - -Where `ACTIVATION_KEY` is the one that you got in the previous step. - -If you want to get an IP-based license, run the following commands: - -``` -yum install wget -y -wget https://repo.cloudlinux.com/cloudlinux/sources/cln/cldeploy -bash cldeploy -i --to-solo-edition -``` - -After the successful conversion, reboot your system by running the following command: - -``` -reboot -``` - -#### The cldeploy explanation - -By its design, CloudLinux OS Solo is very close to the upstream operating system, RHEL (and so, CentOS and AlmaLinux). -This makes the conversion process relatively straightforward, requiring just one reboot. - -Here's what the cldeploy script does when you run it: - -* Backups the original repository settings into the`/etc/cl-convert-saved`. -* Backups RHEL system ID into the `/etc/cl-convert-saved` (RHEL systems only). -* Installs CloudLinux repository settings and imports CloudLinux RPM key. -* Replaces redhat/centos-release, redhat-release-notes, redhat-logos with CloudLinux version. -* Re-installs CloudLinux version of rhnlib/rhnplugin. -* Checks for binary kernel modules, finds replacement if needed. -* Detects OVH servers and fixes the mkinitrd issues. -* Detects Linode servers and fixes the grub issues. -* Checks if LES is installed. -* Checks that the `/etc/fstab` has the correct `/dev/root`. -* Checks for efi. -* Installs CloudLinux Manager for cPanel Solo. - -#### Next steps - -Reboot your system, log in and check EULA which is located in the `/usr/share/cloudlinux-release/EULA`. - -:::tip Note -ISO installation provisions server with outdated packages. -It is highly recommended to run `yum update` right after the first boot. -::: - -## Uninstalling - -You can always uninstall CloudLinux OS Solo. In this case, the system will be converted back to CentOS or -AlmaLinux. - -The following actions will be taken: - -* CloudLinux repositories & yum plugin will be removed. -* CentOS or AlmaLinux repositories will be set up. - -In the end, the script will provide instructions on how to finish the conversion back. -That will require removal of the CloudLinux kernel (a manual step), and installing CentOS or AlmaLinux kernel (if needed). - -:::warning Warning -Do not forget to free up a CloudLinux OS Solo license by removing the server from the [Servers section of your CLN account](https://docs.cln.cloudlinux.com/dashboard/#servers) -After that, if you don't intend to use the license anymore, you can [remove it](https://docs.cln.cloudlinux.com/dashboard/#cloudlinux-os-activation-keys) to avoid being billed. -::: - -To uninstall CloudLinux OS, run the following command: - -``` -wget -O cldeploy https://repo.cloudlinux.com/cloudlinux/sources/cln/cldeploy -sh cldeploy -c -``` - -Now you have converted back and it is time to install the kernel. - -To delete the CloudLinux kernel, run the following command (change the kernel package name to the one you've been using): - -``` -rpm -e --nodeps kernel-2.6.32-673.26.1.lve1.4.27.el6.x86_64 -``` - -To install a new CentOS or AlmaLinux kernel once you deleted the CloudLinux kernel, run the following command: - -``` -yum install kernel -``` - -If yum says that the latest kernel is already installed, it is OK. -Please check your bootloader configuration before rebooting the system. - -To remove unused kmods and lve libs, run the following command: - -``` -yum remove lve kmod*lve* -``` - -Before the reboot, the following command should be executed for restoring Apache and httpd.conf without mod_hostinglimits: - -*For EasyApache 3:* - -``` -/scripts/easyapache --build -``` - -*For EasyApache 4:* - -``` -/usr/local/bin/ea_install_profile --install /etc/cpanel/ea4/profiles/cpanel/default.json -``` - -:::tip Note -Some packages from the CloudLinux repo will still remain. They are the same as CentOS or AlmaLinux packages and don't have to be removed. -They will be updated in the future from CentOS repositories, as new versions come out. -::: diff --git a/docs/solo/introduction/README.md b/docs/solo/introduction/README.md deleted file mode 100644 index e194c3d22..000000000 --- a/docs/solo/introduction/README.md +++ /dev/null @@ -1,136 +0,0 @@ -# Introduction - -[[toc]] - -## What is CloudLinux OS Solo - - -CloudLinux OS Solo is designed for installation on VPS or dedicated servers with a single hosting account for any number of websites. - -Unlike [CloudLinux OS Legacy (Shared)](/introduction/), this edition is not designed for Shared Hosting usage and it does not include any [LVE-related](/cloudlinuxos/lve_manager/) features. - -We provide the CloudLinux OS Solo with pre-installed features, but for grafical interface, please install a control panel on your server. - -:::warning -Currently supported OS version is CloudLinux OS Solo 8+ only. Therefore, for now, there is no possibility to use CloudLinux OS Solo on servers with OS version 6 and 7. -Please refer to the [currently supported OS versions](/introduction/#cloudlinux-os-solo-lifecycle). -::: - -#### Supported control panels - -|**Panel**|**Supported**| -|:-:|:-:| -|cPanel Solo|Yes| -|cPanel regular with one user|Yes| -|Plesk|Yes| -|DirectAdmin|Yes| -|Other panels|Yes| -|No control panel|Yes| - -#### CloudLinux OS editions comparison - - -|**Features**|**CloudLinux OS Solo**|**CloudLinux OS Admin**|**CloudLinux OS Legacy (Shared)**|**CloudLinux OS Shared Pro**| -|:-:|:-:|:-:|:-:|:-:| -|Maximum amount of hosting accounts|1|5|unlimited|unlimited| -|Resource Limits (LVE)|No*|**Yes****|**Yes**|**Yes**| -|Cage FS|**Yes**|**Yes**|**Yes**|**Yes**| -|MySQL Governor|No|No|**Yes**|**Yes**| -|PHP Selector|**Yes**|**Yes**|**Yes**|**Yes**| -|Python/Node.js Selectors|**Yes*****|**Yes*****|**Yes*****|**Yes*****| -|Ruby Selector|No|**Yes*****|**Yes*****|**Yes*****| -|HardenedPHP|**Yes**|**Yes**|**Yes**|**Yes**| -|Apache mod_lsapi PRO|**Yes**|**Yes**|**Yes**|**Yes**| -|SecureLinks|No|**Yes**|**Yes**|**Yes**| -|Website monitoring tool|**Yes**|**Yes**|**Yes**|**Yes**| -|Website monitoring alerts|**Yes**|**Yes**|**Yes**|**Yes**| -|Slow Site analyzer|**Yes**|**Yes**|**Yes**|**Yes**| -|PHP X-Ray|**Yes**|**Yes**|No|**Yes**| -|Centralized Monitoring|No|No|No|**Yes**| -|AccelerateWP|**Yes**|**Yes**|No|**Yes**| -|Support 24/7|**Yes**|**Yes**|**Yes**|**Yes**| - -\* Only inodes limits are available. - -\** Limits are disabled by default. - -\*** Python/Node.js/Ruby Selectors are available only for cPanel, DirectAdmin servers, and servers with custom panel with own integration. - - -### Benefits - -We believe that this distribution will be useful for you if: -1. as a site owner you have different performance issues with websites hosted. - CloudLinux OS Solo provides a set of tools for website monitoring and performance tracking out-of-box; -2. as a service provider you sell VPS servers and some of your customers require OS with extensive features - for better security, support, and performance. - -In any case we provide you [24/7 professional support](https://cloudlinux.zendesk.com/) -to resolve any issues related to CloudLinux OS, its unique components and kernel. - -### CloudLinux OS Solo features - -We've pre-installed a couple of useful features in our distribution. The complete list of supported features is available in the [table above](/solo/introduction/#cloudlinux-os-editions-comparison). - -* **CloudLinux Manager** - - CloudLinux Manager is a plugin which allows you to control all the - CloudLinux settings from an easy-to-use web UI integrated into your control panel. - - The sub-modules you can find in CloudLinux Manager are Website Monitoring tool, PHP Slow Site analyzer, and X-Ray. - - [See more](/solo/manager/). - -* **Website Monitoring tool** - - Website Monitoring tool is a tool that allows you to track your websites uptime - and receive notifications about problems with access. - - Website Monitoring tool can gather and display information regarding the slowest websites on the server, - notify by emails about errors happened on websites and send you daily website performance reports. - - [See more](/solo/manager/#website-monitoring-tool). - -* **PHP Slow Site analyzer** - - PHP Slow Site analyzer (SSA) is a tool that generates daily reports for the server administrator - with information about the top N slow PHP-based URLs for all domains. - - The Slow Site analyzer tracks all PHP-based requests and selects slow ones by specific rules. - - [See more](/solo/manager/#php-slow-site-analyzer). - -* **X-Ray** - - X-Ray is a tool developed for website performance monitoring and performance issues detection. - - X-Ray can gather and visualize information about top slowest system functions, external requests, - software modules and database queries of the client’s PHP website. - - [See more](/solo/manager/#x-ray). - -### How can I try your distribution before paying for it? - -We provide trial licenses for 30 days. You can get your trial key in two ways: - -1. On the CloudLinux OS Solo main page, see [CloudLinux OS Solo](https://lp.cloudlinux.com/cloudlinux-os-solo). -2. In the CloudLinux Manager plugin, see the [Getting trial key](/solo/manager/#activation) section. - - -The trial key must be entered during installation. - -### CloudLinux OS Solo lifecycle - -CloudLinux OS Solo has the same life cycle policy as RHEL. -Using a supported operating system is critical to maintaining a stable server environment. - -Currently, the following version are supported: - -|Operating System | Release Date| End of Life and Support| -|-|--|-| -|CloudLinux OS Solo 8 | Jun 1, 2021 | May 31, 2029 | - -## What's next - -1. The [Installation](/cloudlinuxos/installation) section contains information about how to install this OS. -2. The [landing page](https://lp.cloudlinux.com/cloudlinux-os-solo) contains the instructions about how to buy license or get trial. diff --git a/docs/solo/manager/.DS_Store b/docs/solo/manager/.DS_Store deleted file mode 100644 index c05184e38..000000000 Binary files a/docs/solo/manager/.DS_Store and /dev/null differ diff --git a/docs/solo/manager/README.md b/docs/solo/manager/README.md deleted file mode 100644 index 4417caea9..000000000 --- a/docs/solo/manager/README.md +++ /dev/null @@ -1,1888 +0,0 @@ -# CloudLinux Manager - -[[toc]] - -CloudLinux 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 all CloudLinux OS Solo features. - -CloudLinux Manager (previously LVE Manager) is accessible via the *Server Configuration* tab: - -![](/images/solo/manager/howtofindlvemanagerinpanel.webp) - - -:::warning Warning -LVE Manager is renamed to CloudLinux Manager since cPanel v 96.0.9 -::: - - -![](/images/solo/manager/solo_lvemanagermainmenu.webp) - -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; -* Users tab - provides access to manage user limits; -* Options tab - provides access to user interface settings, CageFS and Python/NodeJs selectors; -* Website Monitoring provides access to Website Monitoring and PHP Slow Site Analyzer; -* X-Ray tab - provides access to X-Ray; -* Selector tab - provides access to PHP Selector; -* Smart Advice tab - provides ability to see advice list generated for your WordPress websites; -* AccelerateWP tab - provides access to AccelerateWP; - - -## Activation - -To start using CloudLinux Manager, it must be activated with your CloudLinux OS Solo activation key. - -In order to activate CloudLinux Manager features, follow the next steps: - -* Enter your CLN activation key if you already have it - ![](/images/solo/manager/cloudlinuxmanageractivation.webp) - - If you have IP-based license, please leave the _Enter Activation Key_ field empty and just click _Activate_. - - You can read more about CloudLinux OS Solo and how to get the license [here](https://lp.cloudlinux.com/cloudlinux-os-solo) - -## Website Monitoring tool - -**Website Monitoring tool (WMT)** is a tool that collects the statistics of the domains' availability and responsiveness, as well as errors that occur when accessing these domains. An admin can get email reports with the statistics. The Website Monitoring tool uses the simple curl request like `curl http://domain.com` to get domains’ statistics. - -You can configure the Website Monitoring tool and the [Slow Site analyzer](/solo/manager/#php-slow-site-analyzer) and view the daily reports in the CloudLinux Manager -> Website monitoring tab. - -There are Main, PHP Site analyzer, and Settings subtabs [here](/solo/manager/#main). - -:::warning Warning -For now, there is no any possibility to remove the `alt-php-ssa` and `cl-web-monitoring-tool` packages so that the _Website monitoring_ tab will be removed. -You can turn off the _Website monitoring_, _PHP Sites Analyzer_ in the _[Settings](/solo/manager/#wmt-settings)_ tabs, so sites statistics will stop collecting and there will be no additional load on the server. -::: - -#### Main - -This subtab views the latest report (for the last 24 hours) of the Website monitoring tool. - -![](/images/solo/manager/WebsiteMonitoringMain.webp) - -Report is regenerated each time the page is loaded, so all changes in configuration (the [_Settings_](/solo/manager/#wmt-settings) tab) or in the list of domains will be applied immediately. - -* **Total number of requests** - requests that were sent to all domains, existing on the servers -* **Successful requests** - the number of requests for all domains with status code 200 -* **Requests with errors** - the number of requests for all domains which status code is not 200 -* **Not started requests due to short check interval** - this metric is used to adjust configuration. If it is not equal 0, an admin should increase the value of Requests sending interval, because the tool does not fit into this interval to send requests to all domains. -* **Slowest websites in 24h and Websites with most errors in 24h** - in these sections you can find the number of domains that was exposed here. - -### WMT Settings - -To enable or disable **Website Monitoring**, use the following slider. - -![](/images/solo/manager/WebsiteMonitoringSlider.webp) - - -* **Email to send report** - all email notifications will be sent to this email address - -:::warning Warning -If email is not specified, all [notifications](/solo/manager/#wmt-email-notifications) will be sent to control panel administrator's email. -::: - -![](/images/solo/manager/Webmonitoringtoolsettings.webp) - -* **Enable summary notifications** - turn on/off summary daily email report notifications -* **Enable alert notifications** - turn on/off immediate alert email notifications -* **Domains and URLs Ignore List** - domains and URLs that will not be requested and displayed in reports; supported formats: `example.com, http://example.com` -* **Top N slow websites to show** - this number (N) will be used to select the top N domains from the list of all domains, sorted by response duration (Slowest websites list). And this number also will be used to select the top N domains from the list of all domains, sorted by amount of errors (Websites with most errors list). -* **Check every X minutes** - this is a period in minutes between requests to the same domain. -* **Time allowed for response** - if there is no answer from the website for this period of time, the Website Monitoring tool will regard this behaviour as the `HTTP 408` error. -* **Concurrent requests limit** - how many concurrent requests can be done by the Website Monitoring tool. - -### WMT CLI - -The `wmt-api` utility allows managing Website Monitoring tool via CLI. - -**Usage** - -``` -# /usr/share/web-monitoring-tool/wmtbin/wmt-api [command] [--optional arguments] -``` - -**Optional arguments**: - -| | | -|-|-| -|`-h`, `--help`|show help message and exit| - -**Commands**: - -| | | -|-|-| -|`config-change`|set the WMT configuration using the JSON string that follows the command| -|`config-get`|get the WMT configuration as JSON| -|`report-get`|generate a report for last 24 hours| -|`send-clickhouse`|send the summary report to the ClickHouse| -|`start`|start the WMT system| -|`status`|check the status of the WMT system| -|`stop`|stop the WMT system| - -Example of the `/usr/share/web-monitoring-tool/wmtbin/wmt-api` command usage: - -``` -/usr/share/web-monitoring-tool/wmtbin/wmt-api --config-change "{\"ping_timeout\":10,\"ping_interval\":5,\"report_email\":\"user@example.com\"}" -``` - -This way you can set all or only certain parameters. - -### WMT email notifications - -There are two types of emails sent by the Web Monitoring tool: **daily email report** and **alert**. - -#### Daily email report - -The summary report with all data for the previous day. It is created and sent every day at midnight. - - -**Example of the Web Monitoring tools daily report**. - -![](/images/solo/manager/Webmonitoringtoolemail.webp) - -#### Alert - -Domains that are responding with non-200 status code will be re-requested in 5 minutes or in the `ping_interval` setting (in case it is less than 5 minutes). - -If domains are still responding with non-200 status code - Web Monitoring tool will inform about such domains with immediate alert email. - -**Example of the Web monitoring tools immediate alert**. - -![](/images/solo/manager/Webmonitoringtoolalert.webp) - -:::tip Note -The next alert with domains will not be sent in less than 6 hours. Also, if the alerted domain is still responding with non-200 status code even after 6 hours - it will not be re-alerted until it responds with 200 status code at least once and becomes unavailable again. -::: - -## PHP Slow Site analyzer - -**PHP Slow Site analyzer** (**SSA**) is a tool that generates daily reports for the server administrator with information about the top N slow PHP-based URLs for all domains. The Slow Site analyzer tracks all PHP-based requests and selects slow ones by specific rules. - -![](/images/solo/manager/solo_SlowSiteAnalyzerReport.webp) - -This is an example of a report from the Slow Site analyzer. The report shows the number of slow requests per domain and its URLs and the average duration of each slow URL. - - -### SSA settings - -To enable or disable the **Slow Site analyzer**, use the following slider: - -![](/images/solo/manager/WebsiteMonitoringSlider1.webp) - -The following settings can be changed through the UI: - -![](/images/solo/manager/solo_SlowSiteAnalyzerSettings.webp) - -* **Enable Autotracing** - turn on/off Autotracing; -* **Enable summary notifications** - turn on/off summary daily email report notifications; -* **Top N slow websites to show** - Set the number of top slow websites to show in the “PHP Sites Analyzer“ report; -* **Top slow URLs** - this number (N) will be used to select the top N URLs for each domain, marked as slow; -* **Slow request duration** - the duration of a request in seconds. If the request duration was less than specified in this setting then this request will not be marked as slow; -* **Slow requests number** - number of slow requests in the period of time to mark the URL as a slow one; -* **Analysis time** - the period of time in hours required to analyze slow requests; -* **Enable slow requests density threshold** - turn on/off slow requests density threshold; -* **Slow requests density threshold** - can be in the interval [0..1], by default it is 0.8. The **density threshold** can be disabled. And the **Domains and URLs Ignore List** can be specified; -* **Domains and URLs Ignore List** - domains and URLs that will not be displayed in reports; - - - -### SSA CLI - -The `cloudlinux-ssa-manager` utility allows to manage Slow Site analyzer via CLI. - -**Usage** - -``` -/usr/sbin/cloudlinux-ssa-manager [command] [--optional arguments] -``` - -**Optional arguments**: - -| | | -|-|-| -|`-h`, `--help`|show help message and exit| - -**Commands**: - -| | | -|-|-| -|`set-config`|set the SSA configuration| -|`get-config`|get the SSA configuration| -|`get-ssa-status`|get a current status of SSA| -|`enable-ssa`|enable SSA| -|`disable-ssa`|disable SSA| -|`get-report`|get the latest report| - -You can use the `-h`, `--help` option with commands to get a full list of available optional arguments for each command. - -Example of the `/usr/sbin/cloudlinux-ssa-manager get-report | json_reformat` command output: - -``` -/usr/sbin/cloudlinux-ssa-manager get-report | json_reformat - -{ - "result": "success", - "date": "18.05.2021", - "domains": [ - { - "name": "user1.com", - "slow_urls": 2, - "slow_reqs": 23, - "total_reqs": 24, - "urls": [ - { - "name": "http://user1.com/", - "reqs_num": 13, - "average_duration": 3004509 - }, - { - "name": "http://user1.com/info.php", - "reqs_num": 10, - "average_duration": 3641018 - } - ] - }, - { - "name": "user2.com", - "slow_urls": 1, - "slow_reqs": 12, - "total_reqs": 12, - "urls": [ - { - "name": "http://user2.com/", - "reqs_num": 12, - "average_duration": 3010571 - } - ] - } - ] -} -``` - -Example of the `/usr/sbin/cloudlinux-ssa-manager set-config --requests-duration 2.5` command output: - -``` -/usr/sbin/cloudlinux-ssa-manager set-config --requests-duration 2.5 - -{"result": "success"} -``` - - -### SSA email notifications - -SSA sends email reports daily if the "**Enable summary notifications**" setting is turned on. - -**Example of the PHP Slow Site analyzer report**: - -![](/images/solo/manager/solo_SlowSiteAnalyzerEmailNotifications.webp) - - -## X-Ray - -* [Description](/solo/manager/#description) -* [How to manage X-Ray](/solo/manager/#how-to-manage-x-ray) -* [Managing tracing task](/solo/manager/#managing-tracing-task) -* [Managing continuous tasks](/solo/manager/#managing-continuous-tasks) -* [X-Ray Autotracing](/solo/manager/#x-ray-autotracing) -* [End-user X-Ray plugin](/solo/manager/#end-user-x-ray-plugin) -* [X-Ray client](/solo/manager/#x-ray-client) -* [X-Ray service](/solo/manager/#x-ray-agent) -* [FAQ](/solo/manager/#faq) - -### Description - -X-Ray is a tool developed for website performance monitoring and performance issues detection. - -X-Ray can gather and visualize information about top N slowest system functions, external requests, software modules and database queries of the website. - -### How to manage X-Ray - -X-Ray provides two options for monitoring domain requests speed: Tracing task and Continuous task. - -* **Tracing task** is a task created manually for a specific URL to collect server requests. The task will end either after a specified number of requests to the URL or after a specified time (maximum after two days). It is not possible here to automatically email a report but it is possible to export the report in PDF and send to a user. - -* **Continuous task** is a task that initiates a daily hourly tracing requests for a specified domain and email a monitoring report. Continuous task can't stop automatically, you need to stop it manually. - -In fact, continuous task allows to automatically create a tracing task for each new day, with the ability to get a report for the past day. - - -## X-Ray serverwide mode - -With X-Ray v0.6-11 we introduced global X-Ray mode which enables tracing extension for all PHP versions on the servers. This -mode allows your customers to [override PHP versions](https://cloudlinux.zendesk.com/hc/en-us/articles/115004537805-Different-PHP-versions-per-directories-using-mod-lsapi) -in different folders and trace websites located in those folders. - -In order to enable this mode, type the following command: -``` -cloudlinux-xray-manager enable-serverwide-mode -``` - -In order to get back to default: -``` -cloudlinux-xray-manager disable-serverwide-mode -``` - -Enable and disable commands do not stop or remove tracing tasks. - -## X-Ray phpinfo mode - -With X-Ray v0.6-18 we introduced new X-Ray mode which gathers website php version using information from phpinfo. This -mode allows your customers to [override PHP versions](https://cloudlinux.zendesk.com/hc/en-us/articles/115004537805-Different-PHP-versions-per-directories-using-mod-lsapi) - -:::warning -In order to use this mode, websites should be reachable through http or https. -::: - -In order to enable this mode, type the following command: -``` -touch /opt/cloudlinux/flags/enabled-flags.d/xray-per-domain-php-version-mode.flag -``` - -In order to get back to default: -``` -rm -f /opt/cloudlinux/flags/enabled-flags.d/xray-per-domain-php-version-mode.flag -``` - - -#### Tracing tasks tab - -The *Tracing tasks* tab contains a list of all tracing tasks created both manually and automatically via continuous tasks. - -![](/images/solo/manager/XRayTracingTaskCreated.webp) - -The *Created* column shows how a task was created – automatically (by continuous task) or manually. - -#### Continuous tracing tab - -The *Continuous tracing* tab contains a list of continuous tasks for which tracing tasks will be created automatically for a new day for a specific domain. - -![](/images/solo/manager/XRayContinuousTasksList.webp) - -### Managing tracing task - -#### Creating a new tracing task - -1. Go to the _X-Ray_ tab -2. Click the _Start tracing_ button to create a new task -3. In the opened popup specify a website URL to trace -4. Click the _Run_ button -5. Tracing will run in the default mode. In the default mode X-Ray traces the first 20 requests for a specified URL - -![](/images/solo/manager/XRayTracingTask.webp) - -* **URL** should be a valid URL of the domain which exists on the current hosting server. The URL field supports wildcard matching. To learn more about wildcard matching, click _How to use special characters_. -* **Advanced settings** allow you to set an IP address and tracing options: by time or by number of queries. - - ![](/images/solo/manager/XRayAdvanced.webp) - -**Advanced settings** - -* **Client’s IP**: it is an IPv4 address of a machine to trace. For example, if you have a production website that processes requests from different IP addresses and you do not want to add these requests to the tracing task. So, you can set a specific IP address and X-Ray will analyze requests only from this specific IP address. -Record for -* **Time period**: how much time X-Ray collect the requests (2 days max) -* **Requests**: the amount of requests that X-Ray will collect - -After creating, the task appears in the list of tracing tasks. - -![](/images/solo/manager/XRayTrcingTaskList.webp) - -#### Viewing tracing tasks list - -![](/images/solo/manager/XRayTrcingTaskList1.webp) - -Tasks created *Manually* are simply tracing tasks. - -#### Tracing status - -A tracing task can have the following statuses: - -* **Running** – tracing is in progress -* **Stopped** – tracing was stopped by administrator -* **On hold** – the same URL already exists in the lists. Task processing will not start automatically. Administrator should start it manually. -* **Completed** – period of time is finished or number of requests is reached. - -#### Collected requests for tracing task - -:::warning Warning! -Collected requests are available in the UI for two weeks. -::: - -Click ![](/images/solo/manager/XRayView.webp) to open a list of collected requests. - -#### Tracing tasks - -![](/images/solo/manager/solo_XRayCollectedRequests.webp) - -The slowest request is highlighted. - -![](/images/solo/manager/XRaySlowestRequest.webp) - -* **Total** displays how many requests were collected according to tasks requirements. -* **Pending** displays how many of collected requests are not visible in the table yet. -* **Slow** displays the number of requests lasting more than one second. - -There are filters for the request types and the indicator of a filter used now. - -![](/images/solo/manager/FilterIndicator.webp) - -If slow requests were not detected during the tracing task, the following is displayed. Here, you can also view all requests. - -![](/images/solo/manager/solo_RecordedSession.webp) - - -X-Ray collects the following data for each request: - -* **Top issues** – the slowest items of a request -* **Software modules/plugins** by execution time (only for WordPress plugins) -* **Database queries** by execution time -* **External requests** by execution time -* **Other system functions** by execution time - -#### Software modules/plugins - -![](/images/solo/manager/XRaySoftwareModulesPlugins.webp) - -The _Software modules/plugins_ section displays the following data: - -* **Software type** – a type a module/plugin. For now, X-Ray can analyze only WordPress software -* **Software module** – a name of the WordPress plugin -* **Duration** – plugin execution time -* **Duration (%)** – plugin execution time as a percentage of the total duration of the request - -#### Database queries - -![](/images/solo/manager/XRayDatabaseQueries.webp) - -The _Database queries_ section displays the following data: - -* **Query** – the executed SQL-query -* **File** – the file and the line of the executed query and backtrace -* **Software module** – a WordPress plugin name from which the request was completed. If the request does not belong to any of the WordPress plugin, the name of the function that executed the given request is displayed -* **Calls** – the number of identical SQL queries -* **Duration** – execution time as a percentage of the total duration of a request and the function processing time (in brackets) - -#### External requests - -![](/images/solo/manager/XRayExternalRequests.webp) - -The _External requests_ section displays the following data: - -* **URL** – the URL of the executed request -* **File** – the file and the line of the executed request and backtrace -* **Duration** – execution time as a percentage of the total duration of a request and the function processing time (in brackets) - -#### System functions - -![](/images/solo/manager/XRaySystemFunctions.webp) - -The _System functions_ section displays the following data: - -* **Function** – the executed function -* **File** – the file and the line of the executed request -* **Duration** – execution time as a percentage of the total duration of a request and the function processing time (in brackets) - -#### Stopping tracing task - -Click ![](/images/solo/manager/XRayStop.webp) to stop the tracing task. - -![](/images/solo/manager/XRayStopped.webp) - -The tracing task status will be changed to **Stopped**. Data will not be collected anymore but you can see already collected information or continue tracing later by clicking ![](/images/solo/manager/XRayStart.webp). - -#### Deleting tracing task - -Click ![](/images/solo/manager/XRayDelete.webp) to delete the tracing task. - -:::warning Warning! -When you have deleted a tracing task, all collected data will be unavailable. -::: - -### Managing continuous tasks - -#### Creating a new continuous task - -1. Click the *Create continuous tracing* button - -![](/images/solo/manager/XRayCreateContinuousTaskBtn.webp) - -2. Specify URL in the *Domain* field and email in the *Email for reports* field and click the *Create* button. - -![](/images/solo/manager/XRayCreateContinuousTaskForm.webp) - -3. You can see a new task in the *Continuous tracing* tab in the X-Ray UI. - -![](/images/solo/manager/XRayContinuousTracingTab.webp) - -4. If you stop a continuous tracing task, a new task for the next 24 hours will not be created. The task for the current day will be finished at midnight and the report will be emailed. - -5. If you delete a continuous tracing task, the task for the current day will be finished at midnight and the report will be emailed. - -#### Viewing continuous tasks list - -You can find a list of continuous tracing tasks in the _Continuous tracing_ tab. - -![](/images/solo/manager/XRayContinuousTracingTasksList.webp) - -You can find automatically created tasks in the _Tracing tasks_ tab marked as _Automatically_ in the _Created_ column. - -![](/images/solo/manager/XRayContinuousTracingTasksListCreated.webp) - -The [statuses for automatically created tasks](/solo/manager/#tracing-status) are the same as for tracing task. - -To view detailed info about an automatically created task, click ![](/images/solo/manager/XRayView1.webp). You will get requests grouped by hour. - -![](/images/solo/manager/XRayContinuousTracingTasksListGrouped.webp) - -Click to a group to open a list of the requests. - -![](/images/solo/manager/XRayContinuousTracingTasksRequestsList.webp) - -The following data is collected for each request: - -* Software modules/plugins by execution time (only for WordPress plugins) -* Database queries by execution time -* External requests by execution time -* Other system functions by execution time - -#### Stopping automatic tracing task - -Stopping automatic tracing task (a part of continuous tracing task) affects only the automatic tracing task for the current day. A new task for the next day will be created at the end of the day. - -To stop the continuous tracing task completely, see [Creating a new continuous task, paragraph 4](/solo/manager/#creating-a-new-continuous-task). - - -#### Deleting automatic tracing task - -Deleting automatic tracing task (a part of continuous tracing task) affects only the automatic tracing task for the current day. A new task for the next day will be created at the end of the day. - -To delete the continuous tracing task completely, see [Creating a new continuous task, paragraph 5](/solo/manager/#creating-a-new-continuous-task). - - -#### Continuous task daily report - -1. Users get daily reports on their emails. An example of a report is shown below: - - ![](/images/solo/manager/XRayContinuousTaskDaylyReportExample.webp) - -2. Click the link in the email to show the detailed report: - - ![](/images/solo/manager/XRayContinuousTaskDaylyReportCollectedRequests.webp) - -3. You can view requests grouped by hour: - - ![](/images/solo/manager/XRayContinuousTaskDaylyReportByHourRequests.webp) - -4. You can also view the detailed information about request: - - ![](/images/solo/manager/XRayContinuousTaskDaylyReportRequestDetails.webp) - - -### X-Ray Autotracing - -X-Ray Autotracing automatically creates tracing tasks for slow URLs that were found during a day by the [PHP Slow Site Analyzer](/cloudlinuxos/lve_manager/#website-monitoring-tool-and-slow-site-analyzer) (SSA). - -:::warning Warning -To use X-Ray Autotracing, update your alt-php-ssa and alt-php-xray packages to versions alt-php-ssa-0.2-1 and alt-php-xray-0.4-1 or higher by running the following command: -``` -yum update alt-php-ssa alt-php-xray --enablerepo=cloudlinux-updates-testing -``` -::: - -#### How to enable X-Ray Autotracing - -To enable X-Ray Autotracing, run the following commands via SSH: - -``` -/usr/sbin/cloudlinux-ssa-manager enable-ssa -/usr/sbin/cloudlinux-xray-autotracing enable --all -``` - -Check [CLI documentation](/solo/manager/#x-ray-autotracing-cli) for a description of the `/usr/sbin/cloudlinux-xray-autotracing` CLI utility. - -#### Requirements - -* CloudLinux OS Shared Pro or CloudLinux OS Solo -* alt-php-ssa > 0.2-1 version -* alt-php-xray > 0.4-1 version -* Enabled PHP SSA on the server - -#### Autotracing Interface - -A new tab for Autotracing tasks was added to the X-Ray UI: - - -![](/images/solo/manager/XRayAutotracingtaskstab.webp) - - -#### Autotracing FAQ - -Q: Why are the slow URLs in the Slow Site Analyzer report different from those on which the autotracing tasks were created? - -A: Because the autotracing decision module uses rules and thresholds different from Slow Site Analyzer, which are configured by the CloudLinux team. - -Q: How often autotracing tasks will be generated? - -A: Once a day at the same time as a Slow Site Analyzer report. - - -#### X-Ray Autotracing CLI - - -The `cloudlinux-xray-autotracing` utility allows to manage the X-Ray Autotracing via CLI. - -**Usage** - -``` -/usr/sbin/cloudlinux-xray-autotracing [command] [--optional arguments] -``` - -**Commands**: - -| | | -|-|-| -|`enable`|Enable X-Ray Autotracing| -|`disable`|Disable X-Ray Autotracing| -|`status`|Get current status of the X-Ray Autotracing| - -**Optional arguments**: - -| | | -|-|-| -|`-h`, `--help`|Show help message and exit| -|`--all`|Enable or disable for all users| -|`{username}`|Enable/disable the specified user| -|`--list-disabled`|Show list of disabled users| - -You can use the `-h`, `--help` option with commands to get a full list of available optional arguments for each command. - -**Example usage:** - -Disable user1: - -``` -/usr/sbin/cloudlinux-xray-autotracing disable user1 - -{"result": "success"} -``` - -Show list of disabled users: - -``` -/usr/sbin/cloudlinux-xray-autotracing status --list-disabled - -{"result": "success", "disabled_users": ["user1"]} -``` - -Enable all: - -``` -/usr/sbin/cloudlinux-xray-autotracing enable --all - -{"result": "success"} -``` - - -### X-Ray Smart Advice - -Smart advice is a new feature of X-Ray that is designed to find and propose solutions to fix performance issues and speed up the performance of a sites. - -:::tip Note -Smart Advice will work only for CloudLinux OS Solo servers with cPanel or Plesk Control Panel for now. - -At the moment, Smart Advice is focused only on WordPress sites. -::: - -:::warning Warning -To use X-Ray Smart Advice, update your alt-php-ssa and alt-php-xray packages to versions alt-php-ssa-0.2-3 and alt-php-xray-0.5-1 or higher by running the following command: -``` -yum update alt-php-ssa alt-php-xray lve-utils lvemanager --enablerepo=cloudlinux-updates-testing -``` -::: - -#### Requirements - -* CloudLinux OS Shared Pro or CloudLinux OS Solo -* alt-php-xray > 0.5-1 version -* lve-utils > 6.3.2-1 version -* lvemanager > 7.6.1-1 version -* cloudlinux-site-optimization-module > 0.1-1 version - -We Recommend: - -* Enable [X-Ray Autotracing](/solo/manager/#x-ray-autotracing) on the server -* Use alt-php-ssa > 0.2-3 version - -#### How X-Ray Smart Advice works - -The main process of looking for advice is X-Ray tracing tasks. The best way for doing this is to enable X-Ray Autotracing. -This will allow you to most effectively find Smart Advice for sites that have performance issues without your manual participation. -You can find information on how to enable X-Ray Autotracing [here](/solo/manager/#how-to-enable-x-ray-autotracing). -On the other hand, you can create tracing tasks manually or use continuous X-Ray but we suggest you use X-Ray Autotracing for this purpose. - -:::tip Note -Advice will not be generated by old tracing tasks. -::: - -While the tracing task is running, X-Ray will look for places where advice can be applied. New advice will be displayed on the *Smart Advice* tab. - - -#### Smart Advice FAQ - -Q: Why I can't see new advice on the *Smart Advice* tab? - -A: For the generating of advice, it is necessary to run X-Ray tracing tasks, the best way to do it without manual interaction is to use X-Ray Autoracing. You can find more information on how to enable X-Ray Autotracing [here](/solo/manager/#how-to-enable-x-ray-autotracing). - -#### Useful Smart Advice CLI commands - -:::warning Warning! -This is an experimental feature. The backwards compatibility is not guaranteed. -::: - -To obtain the full list of advice generated for your server use the following CLI command: - -``` -cl-smart-advice list -``` - -For each advice in the list the CLI command returns the following information: -* `metadata`, which includes information about `username`, `domain` and `website` for which the advice is issued -* `advice` information: - * its identifier `id` - * its `type` - * its `status` -- `review` or `applied` - * if advice is Premium `is_premium` - * other internal informational fields - -The example output is given below: - -``` -{ - "data": [ - { - "created_at": "2023-04-11T07:33:48.191870+00:00", - "updated_at": "2023-04-11T07:33:48.191870+00:00", - "metadata": { - "username": "user16", - "domain": "user16.com", - "website": "/wordpress" - }, - "advice": { - "id": 23484, - "type": "OBJECT_CACHE", - "status": "review", - "description": "Turn on Object Caching", - "is_premium": true, - "module_name": "object_cache", - "subscription": { - "status": "no", - "upgrade_url": null - }, - "total_stages": 0, - "completed_stages": 0, - "detailed_description": "To improve site performance, enable the Object Caching We recommend applying the advice if you see it frequen -tly for the most valuable URLs of your site." - } - }, - { - "created_at": "2023-04-11T07:33:48.297784+00:00", - "updated_at": "2023-04-11T08:51:42.362117+00:00", - "metadata": { - "username": "user16", - "domain": "user16.com", - "website": "/wordpress" - }, - "advice": { - "id": 23485, - "type": "SITE_OPTIMIZATION", - "status": "applied", - "description": "Turn on AccelerateWP feature", - "is_premium": false, - "module_name": "accelerate_wp", - "total_stages": 0, - "completed_stages": 0, - "detailed_description": "To improve site performance, enable the AccelerateWP optimization feature. We recommend applying the advice if you see it frequently for the most valuable URLs of your site." - } - } - ], - "result": "success", - "timestamp": 1681203110 -} -``` - - -### End-user X-Ray plugin - -Please refer to the [CloudLinux OS Solo user documentation](/user-docs/user-docs-solo-cloudlinux/#end-user-x-ray-plugin). - - -### X-Ray client - -X-Ray client is a PHP extension named `xray.so`. It analyzes the processing time of the entire request and its parts and then sends the data to the X-Ray agent. - -#### List of supported PHP versions - -The list of currently supported PHP versions: - -| | | | | | -|-|-|-|-|-| -|**ALT PHP**:|**EA PHP**:|**Plesk PHP**|**DirectAdmin PHP**|**Other panels PHP**| -|
  • alt-php54
  • alt-php55
  • alt-php56
  • alt-php70
  • alt-php71
  • alt-php72
  • alt-php73
  • alt-php74
|
  • ea-php54
  • ea-php55
  • ea-php56
  • ea-php70
  • ea-php71
  • ea-php72
  • ea-php73
  • ea-php74
|
  • php54
  • php55
  • php56
  • php70
  • php71
  • php72
  • php73
  • php74
|
  • php54
  • php55
  • php56
  • php70
  • php71
  • php72
  • php73
  • php74
|
  • 54
  • 55
  • 56
  • 70
  • 71
  • 72
  • 73
  • 74
| - - -#### Functions that X-Ray client can hook - -#### Database queries - -* Functions from the [MySQL](https://www.php.net/manual/ru/book.mysql.php) extension: - * `mysql_query` - * `mysql_db_query` - * `mysql_unbuffered_query` -* Functions from the [MySQLi](https://www.php.net/manual/ru/book.mysqli.php) extension: - * `mysqli_query` - * `mysqli::query` - * `mysqli_multi_query` - * `mysqli::multi_query` - * `mysqli_real_query` - * `mysqli::real_query` -* Functions from the [PDO](https://www.php.net/manual/ru/book.pdo.php) extension: - * `PDO::exec` - * `PDO::query` - * `PDOStatement::execute` - -#### External requests - -* Function [curl_exec](https://www.php.net/manual/ru/function.exec) - -#### System PHP functions - -It may be any PHP system function which can be related to a PHP engine or other PHP extension, for example `fopen()` or `json_encode()`. A list of these functions can be found [here](https://www.php.net/manual/en/indexes.functions.php). - -#### Configuration Options - -
- -#### xray.enabled - -
- -**Syntax**: `xray.enabled=On/Off` - -**Default**: On - -**Changeable**: PHP_INI_SYSTEM - -**Description**: Enable or disable X-Ray extension from php.ini - ------ - -
- -#### xray.database_queries - -
- -**Syntax**: `xray.database_queries=[number]` - -**Default**: 20 - -**Changeable**: PHP_INI_SYSTEM - -**Description**: The number of the slowest SQL queries which will be sent to the X-Ray agent. The min value is 0 and the max value is 100. If the variable value is more, the default value will be used. - ------ - -
- -#### xray.external_requests - -
- -**Syntax**: `xray.external_requests=[number]` - -**Default**: 20 - -**Changeable**: PHP_INI_SYSTEM - -**Description**: The number of the slowest external requests (the curl_exec function) which will be sent to the X-Ray agent. The min value is 0 and the max value is 100. If the variable value is more, the default value will be used. - ------ - -
- -#### xray.system_functions - -
- -**Syntax**: `xray.system_functions=[number]` - -**Default**: 20 - -**Changeable**: PHP_INI_SYSTEM - -**Description**: The number of the slowest system functions which will be sent to the X-Ray agent. -The min value is 0 and the max value is 100. If the variable value is more, the default value will be used. - ------ - -
- -#### xray.backtrace_depth - -
- -**Syntax**: `xray.backtrace_depth=[number]` - -**Default**: 10 - -**Changeable**: PHP_INI_SYSTEM - -**Description**: The backtrace depth to the main() function which will be sent to the X-Ray agent. The min value is 0 and the max value is 20. If the variable value is more, the default value will be used. - ------ - -
- -#### xray.processor - -
- - -**Syntax**: `xray.processor=[processor_name]` - -**Default**: xray - -**Changeable**: PHP_INI_SYSTEM - -**Description**: Tells the X-Ray client which processor to use. The new processors may be added in the future. The default processor is xray which means to send data to the X-Ray agent. - ------ - -
- -#### xray.tasks - -
- -**Syntax**: `xray.tasks=host:uri:ip:id` - -**Default**: no value - -**Changeable**: PHP_INI_SYSTEM - -**Description**: The current tracing tasks for the given PHP request. This directive is added automatically by the X-Ray manager when creating a task. It is not allowed to edit manually, as X-Ray may stop working. - ------ - -
- -#### xray.to_file - -
- -**Syntax**: `xray.to_file=On/Off` - -**Default**: Off - -**Changeable**: PHP_INI_SYSTEM - -**Description**: Only for debug purposes. Writes to a file data which is sent to the processor. - ------ - -
- -#### xray.debug - -
- -**Syntax**: `xray.debug=On/Off` - -**Default**: Off - -**Changeable**: PHP_INI_SYSTEM - -**Description**: Only for debug purposes. Enables debug output during request processing. In the On mode can slow down the domain. - ------ - -
- -#### xray.debug_file - -
- -**Syntax**: `xray.debug_file=[path_to_file]` - -**Default**: `/tmp/xray-debug.log` - -**Changeable**: PHP_INI_SYSTEM - -**Description**: Only for debug purposes. Specifies a file for logging debug information. - - -### X-Ray agent - - -This is a service that receives data from the X-Ray client and sends it to the remote storage. - -#### Managing X-Ray service - -The X-Ray agent is managed by the `service` utility. - -* To start the X-Ray agent, run the following command: - -
- - ``` - service xray-agent start - ``` -
- -* To stop the X-Ray agent, run the following command: - -
- - ``` - service xray-agent stop - ``` -
- -* To restart the X-Ray agent, run the following command: - -
- - ``` - service xray-agent restart - ``` -
- -### FAQ - -#### Does X-Ray affect website performance? - -X-Ray affects website performance. Our tests show 5-10 % overhead from a website loading time with X-Ray tracing enabled. -X-Ray allows you to find website performance issues and should not be enabled permanently. If your website is very slow, you can enable X-Ray to find the cause and then disable it. - - -### My customers [override php versions](https://cloudlinux.zendesk.com/hc/en-us/articles/115004537805-Different-PHP-versions-per-directories-using-mod-lsapi) in different folders and X-Ray does not trace those websites, what should I do? - -You should turn on the [X-Ray serverwide mode](#x-ray-serverwide-mode) or the [X-Ray phpinfo mode](#x-ray-phpinfo-mode). - - -#### What should I do if I see the warning "Task is duplicated by URL"? - -This warning means that you already have a task to trace this URL in the list of your tracing tasks. If you see this warning, a new task can be created only with the _On hold_ status and you will be able to run it only when the previous task with the same URL will be completed. - -Note that the URL field supports wildcard matching and you can have a case when X-Ray is tracing the `URL=domain.com/*` and you are trying to create a new task with `URL=domain.com/xray.php`. In this case, you will see that warning because the `*` URLs array includes `xray.php`. - -#### I started a tracing task and made requests to URL but did not see any results in the UI. What should I do? - -1. Check that **xray** extension is enabled for the domain. To do so, go to the `phpinfo()` page and make a request. In the phpinfo output try to find the following section: - - ![](/images/solo/manager/XRayPHPInfo.webp) - -If you cannot see that section, try to restart PHP processes for that user (the simplest way is to restart Apache) and check that you can see the **xray** extension. - - -2. If you can see the **xray** extension in the phpinfo, check that X-Ray agent service is running with the service xray-agent status command. If it is not running, start it with the `service xray-agent start` command. -3. X-Ray may not send data if a site uses a caching plugin, as the caching plugin is outputting HTML, thus there are no PHP scripts to examine. We encountered such issues with sites that use LSCache and WP Super Cache plugins. Check that your site does not use caching plugins. If so, disable it while tracing a site to get information from X-Ray. -4. If you set a client’s IP when creating the tracing task, check that your requests come to the server with this IP via phpinfo (since there may be NAT between your local machine and the server). - - ![](/images/solo/manager/XRayPHPInfoRemoteAddr.webp) - -5. If, after checking the previous items, the issue persists, [contact our support team](https://cloudlinux.zendesk.com/hc/en-us/requests/new). - -#### What to do if X-Ray is not found in the phpinfo() page? - -If you managed to create a tracing task, this means that the `xray.ini` file was created in a system. Therefore, there may be two reasons why it did not appear in the phpinfo page of the domain. - -1. PHP process wasn't reloaded after adding the xray.ini. To solve this, you should restart the Apache or fpm service for the domain on which the tracing was started. At the moment, this is done automatically by the X-Ray manager after creating the task. -2. Your domain uses a PHP version different from the one which was detected by the X-Ray manager. To solve this, check the scan dir for additional ini files for your domain. - - ![](/images/solo/manager/XRayScanDir.webp) - - Then check the `ini_location` that was passed to the X-Ray manager by running the following command: - -
- - ``` - cat /usr/share/alt-php-xray/manager.log | grep ini_location - ``` -
- - Find your tracing task in the output and check that the `xray.ini` exists in this directory, also check that the `ini` path is the same in the phpinfo page output and in the `ini_location` directive for your tracing task. If they are the same, you should reload your PHP. If they are different that means that the X-Ray manager could not correctly determine the PHP version your domain uses. In this case, contact our support team at [https://cloudlinux.zendesk.com/hc/requests/new](https://cloudlinux.zendesk.com/hc/requests/new). - - -#### I use LiteSpeed, X-Ray is enabled and it is shown in the phpinfo() page but does not collect data when sending requests to a site. What to do? - -Check for the `CacheLookup on` option in the `htaccess` file for your domain. -If the option is there, LiteSpeed processes requests bypassing the PHP X-Ray extension. -In this case, to get tracing information, you should remove the `CacheLookup on` option. - -#### What is the proper format for the URL? - -All of the examples below are correct: - -* `http://domain.com` -* `http://domain.com/` -* `https://domain.com` -* `https://domain.com/` - -You can use any of them with a prefix `www.` and it is also correct. - - -## AccelerateWP - -### Get started - -AccelerateWP carries a suite of optimization features that can be enabled and automatically configured for the end-user's site. - -There are AccelerateWP and AccelerateWP Premium feature suites. - -AccelerateWP suite is always enabled when AccelerateWP is turned on. Choose whether you want to offer AccelerateWP Premium -for your users and click "Turn on" to start exploring AccelerateWP. - -![](/images/solo/manager/awp/AWPGettingStarted.webp) - -Once the AccelerateWP suite is enabled by administrator, -end-users will see an AccelerateWP tab in their cPanel interface and be able to activate the optimization feature. - -When AccelerateWP Premium suite enabled by administrator, -end-users will see the Object Caching feature in their interface, -but cannot install the plugin unless they purchase the feature using WHMCS or 3'd party billing. - -#### AccelerateWP suite -This is a basic suite which includes [AccelerateWP base feature](/user-docs/user-docs-shared-pro-cloudlinux/#acceleratewp-feature-wordpress-optimization-plugin): -a WordPress optimization plugin that provides full page caching, GZIP compression and some other useful optimizations. - -**AccelerateWP suite limitations** -* the website must be served with Apache or LiteSpeed web server; -* the website must use PHP version 7.3 or higher. -* the WordPress version must be 5.8 and higher. -* the other WordPress Caching plugins must not be installed. -* the WordPress should not run in Multisite mode. - -:::tip Note -Some AccelerateWP functions depend on external services. For the functions to work properly, the following URLs and IPs need to be allowed at all security levels: - -* https://awp-saas.cloudlinux.com -* 213.239.192.204 -::: - -#### AccelerateWP Premium suite - -:::warning Attention -This feature is free of charge only during the beta testing period. -Afterwards it will be charged. Beta testing period ends no earlier than March 2023. -::: - -This is a premium suite which includes [Object Caching feature](/user-docs/user-docs-shared-pro-cloudlinux/#acceleratewp-premium-object-caching-feature). - -The Object Caching mechanism stores database query results in additional storage for quick access. -This mechanism is really helpful in case if website needs to process multiple pages per second as -requests come in and may be helpful in case when full page caching cannot be used, e.g. on personalized pages. - -**Premium suite limitations** - - -* the website must be served with Apache web server; -* the website must use one of the following PHP handlers: - * [php-fpm](https://blog.cpanel.com/how-to-use-php-fpm-with-cpanel/) - * [lsapi](/cloudlinuxos/cloudlinux_os_components/#apache-mod-lsapi-pro) -* the website must use ea-PHP version 7.4 or 8.0. -* the WordPress version must be 3.7 and higher. -* the other WordPress Caching plugins must not be installed. -* the [Snuffleupagus](https://snuffleupagus.readthedocs.io/) must be turned off. -* the WordPress should not run in Multisite mode. - - - -### Limitations -There are the following requirements to use AccelerateWP: -* the server must have CloudLinux Shared PRO license; -* the server must be powered with cPanel. - - -### Administrator interface - -#### Overview - -In the _CloudLinux Manager → AccelerateWP_ tab Administrator has the opportunity to provide end-user with suites of features, which on its turn could be activated by end-user. To provide best experience, -[activate free features for all WordPress sites](/solo/manager/#activate-free-acceleratewp-for-all-wordpress-sites-on-the-server). - - -![](/images/solo/manager/AWPAdminSolo.webp) - - -By toggling the `Enable AccelerateWP for all users` an administrator provides end-users with AccelerateWP feature. -Once the feature suite is enabled by administrator, end-users will see an AccelerateWP tab in their cPanel interface and be able to activate the optimization feature. - -#### Suites usage statistics -When AccelerateWP is enabled, the AccelerateWP usage statistics is shown. - -![](/images/solo/manager/awp/AWPStats.webp) - -It includes: -* `Active Users` block with total number of users and number of users who has activated the optimization feature/total users -* `Wordpress sites on server` block with total number of WordPress sites and WordPress sites optimized by the feature -* statistics table - -Each row in the statistics table represents a particular user. - -The first column `#of Wordpress sites` shows total number of user's WordPress sites. - -The second column `AccelerateWP` shows number of user's WordPress sites, optimized by the feature. - -In case if both AccelerateWP and AccelerateWP Premium feature suites are enabled, -the statistics is extended with AccelerateWP Premium metrics. - -![](/images/solo/manager/awp/AWPStatsPremium.webp) - -Please notice the `AccelerateWP Premium` rows in the `Active Users` and the `Wordpress sites on server` -blocks, and also the `AccelerateWP Premium` column in statistics table. - -:::tip Note -Newly created users will be accounted for 10 min after adding. -If you want to get updated statistics immediately, use the "Rescan users websites" button. -::: - -#### Filters -You may use the following filters to browse AccelerateWP statistics slices. - -![](/images/solo/manager/awp/AWPFilters.webp) - -* `Users with WordPress sites only` filter will show statistics for users which already have WordPress sites; users without WordPress installations will be hidden -* `Users with AccelerateWP only` filter will show statistics for users who utilizes the AccelerateWP optimization feature; users who did not activated AccelerateWP feature will be hidden -* `Users with AccelerateWP Premium only` filter will show statistics for users who utilizes AccelerateWP Premium (Object Caching) feature; users who did not activated AccelerateWP Premium feature will be hidden - - - -### Activate free AccelerateWP for all WordPress sites on the server -Use the `cloudlinux-awp-admin enable-feature` CLI command to -ensure the best performance for every WordPress site. CLI command -scans a server for all WP sites and activates the AccelerateWP -feature suite. It can take up to 2 minutes for a single site. -CLI command skips activation for WordPress sites with -page caching or feature incompatibilities. - -Scan the server in background mode and activate AccelerateWP -on those WordPress sites where it is possible: -``` -cloudlinux-awp-admin enable-feature --all -``` -The output will denote the -progress state of the process. - -Check activation status: -``` -cloudlinux-awp-admin enable-feature --status -``` -The output will be either: -* Activation is still in progress, -* Activation is done. The message will state how many users -were initially for the scan, a number of WordPress sites with -successfully activated suite, and the total number of WordPress sites -scanned. - -### Disable AccelerateWP for a particular user -Use CLI commands to disable undesired optimization suites for a single user. - -To disable AccelerateWP suite: -``` -cloudlinux-awp-admin set-suite --suites=accelerate_wp --disallowed --users= -``` - -To disable AccelerateWP Premium suite: -``` -cloudlinux-awp-admin set-suite --suites=accelerate_wp_premium --disallowed --users= -``` - -To disable both suites: -``` -cloudlinux-awp-admin set-suite --suites=accelerate_wp,accelerate_wp_premium --disallowed --users= -``` - -### Useful AccelerateWP CLI commands -Use CLI commands to check AccelerateWP features status. - -If you are also interested in Smart Advice CLI command, they could be found [here](/solo/manager/#useful-smart-advice-cli-commands). - -:::warning Warning! -This is an experimental feature. The backwards compatibility is not guaranteed. -::: - -#### AccelerateWP suites statistics - -Get suites statistics: -``` -cloudlinux-awp-admin get-report --all -``` - -This CLI command returns the following information: -* `suites` visibility status - * possible values for visibility status are: `visible`, `allowed`, `disabled` - -The example output is given below: - -``` -{ - "result": "success", - "suites": { - "accelerate_wp": { - "source": "default", - "status": "allowed" - }, - "accelerate_wp_premium": { - "source": "default", - "status": "visible" - } - }, - "timestamp": 1681216482.2929366 -} -``` - -#### AccelerateWP features statistics - -Get overall AccelerateWP features usage statistics for a server with: - -``` -cloudlinux-awp-admin get-stat -``` - -This CLI command returns the following information: -* number of `allowed_users` in `total` and per feature -* number of sites with enabled features in `total` and per feature -- `enabled_sites` -* number of users with visible features in `total` and per feature -- `visible_users` -* features which are currently allowed -- `features_allowed_by_default` -* features which are currently visible -- `features_visible_by_default` - -The example output is given below: - -``` -{ - "allowed_users": { - "object_cache": 0, - "site_optimization": 1, - "total": 1 - }, - "enabled_sites": { - "object_cache": 0, - "site_optimization": 1, - "total": 1 - }, - "features_allowed_by_default": [ - "site_optimization" - ], - "features_visible_by_default": [ - "object_cache", - "site_optimization" - ], - "is_accelerate_wp_flag_enabled": false, - "is_accelerate_wp_icon_enabled": true, - "result": "success", - "timestamp": 1681208259.19426, - "visible_users": { - "object_cache": 1, - "site_optimization": 1, - "total": 1 - } -} -``` - -#### AccelerateWP features detailed statistics - -AccelerateWP features detailed statistics is available in user's environment only. - -Use the following CLI command **_on behalf of a user_**: - -``` -cloudlinux-awp-user get -``` - -The command reports: -* features allowed for a user -- `allowed_features` -* all user's websites `docroots` with features information per each `wps`, which includes: - * status of each feature -- if the feature is `enabled`, if the feature is `visible` - * issues detected (if any) for each feature -* subscription status (for premium features) -- `subscription` -* features visible for a user -- `visible_features` - -The example output is given below: - -``` -{ - "allowed_features": { - "accelerate_wp": [], - "accelerate_wp_premium": [] - }, - "docroots": [ - { - "domains": [ - "user0.com" - ], - "php_handler": "fastcgi", - "php_version": "plesk-php73-fastcgi", - "wps": [ - { - "features": { - "accelerate_wp": { - "enabled": false, - "issues": [ - { - "context": { - "plugins": "WP Rocket" - }, - "description": "Found conflicting plugins: %(plugins)s.", - "fix_tip": "Deactivate and uninstall the conflicting plugin using the WordPress administration interface.", - "header": "Conflicting plugins are enabled", - "type": "incompatibility" - } - ], - "visible": true - }, - "object_cache": { - "enabled": false, - "issues": [ - { - "context": { - "blog_url": "https://blog.cloudlinux.com/", - "supported_handlers": "php-fpm, lsapi" - }, - "description": "Website uses unsupported PHP handler. Currently supported handler(s): %(supported_handlers)s.", - "fix_tip": "Please, set or ask your system administrator to set one of the supported PHP handlers for the domain: %(supported_handlers)s. Or keep watching our blog: %(blog_url)s for supported handlers list updates.", - "header": "Unsupported PHP handler", - "type": "incompatibility" - } - ], - "visible": true - } - }, - "path": "wordpress", - "version": "6.2" - } - ] - }, - { - "domains": [ - "sub.user0.com" - ], - "php_handler": "fastcgi", - "php_version": "plesk-php73-fastcgi", - "wps": [] - } - ], - "max_cache_memory": "64mb", - "result": "success", - "subscription": { - "object_cache": "no" - }, - "timestamp": 1681200081.765476, - "upgrade_url": null, - "used_memory": null, - "visible_features": { - "accelerate_wp": [ - "accelerate_wp" - ], - "accelerate_wp_premium": [ - "object_cache" - ] - } -} -``` - - -#### AccelerateWP disable Redis Object Cache Pro banner - -Depending on the server settings, the `WP_REDIS_DISABLE_BANNERS` constant will be defined in the `wp-config.php` file when the module is activated, which affects the display of promotional materials. - -To change the display of promotional materials for all new installations of the Redis Object Cache module by default, you need to set the settings: - -To display (by default): -```cloudlinux-awp-admin set-options --enable-object-cache-banners``` - -To hide: -```cloudlinux-awp-admin set-options --disable-object-cache-banners``` - -To change the `WP_REDIS_DISABLE_BANNERS` constant for previously installed modules, you need to run a process to update the constant: - -Hide on websites where the module is installed -- for all websites: - ```cloudlinux-awp-admin object-cache-banner --all --disable``` - or - ```cloudlinux-awp-user object-cache-banner --all --disable``` -- for a specific website: - ```cloudlinux-awp-user object-cache-banner --wp-path "/" --domain "demo.com" --disable``` - -Display on websites where the module is installed -- for all websites: - ```cloudlinux-awp-admin object-cache-banner --all --enable``` - or - ```cloudlinux-awp-user object-cache-banner --all --enable``` -- for a specific website: - ```cloudlinux-awp-user object-cache-banner --wp-path "/" --domain "demo.com" --enable``` - -If the banner was previously disabled/enabled for the website, then for its subsequent activation of the ObjectCache module, the general settings at the server level will be applied. This means that for each website we do not store an individual banner disable/enable setting. - - -### WHMCS billing - -CloudLinux developed it's own WHMCS plugin -which provides you AccelerateWP billing integration out of the box. -Check out [the documentation](/cln/whmcs_plugin/) to find how to install and use the plugin. - -### Other billing integration - -As AccelerateWP Premium is the feature that works on subscription basis, -we made it possible for hosters to integrate their existing billing systems with our plugin and sell the -feature for their users. - -When AccelerateWP Premium is enabled in admin interface, users get proposal to upgrade their subscription. - -![](/images/solo/manager/awp/AWPUpgradeNoLink.webp) - -When user upgrades the subscription to the plan with AccelerateWP support, -billing must execute the following command on the server: -``` -cloudlinux-awp-admin set-suite --suites=accelerate_wp_premium --allowed --source=BILLING_OVERRIDE --users= -``` - -This command makes two things: -- allow user to install plugin, bypassing the upgrade window; -- reports premium as being used to CLN, starting the billing cycle for hoster. - - -When user terminates or downgrades plan, the following command must be executed by the billing system: -``` -cloudlinux-awp-admin set-suite --suites=accelerate_wp_premium --default --source=BILLING_OVERRIDE --users= -``` - -### Setup upgrade URL for AccelerateWP Premium - -The upgrade window can be customized with link to the plan upgrade page, which can be set using CLI command: - -``` -cloudlinux-awp-admin set-options --upgrade-url https://plan.upgrade/splash -``` - -![](/images/solo/manager/awp/AWPUpgradeLink.webp) - -AccelerateWP automatically appends GET parameters when the link is displayed. - -``` -https://plan.upgrade/splash/?m=acceleratewp&action=provisioning&username=democom&domain=demo.com&server_ip=10.51.0.10 -``` - -| Parameter | Value | Description | -|-----------|--------------|----------------------------------------------------------| -| m | acceleratewp | Constant. | -| action | provisioning | Constant. | -| username | democom | Customer's account name. | -| domain | demo.com | Customer's account primary domain. | -| server_ip | 10.51.0.10 | Primary IP of the server where AccelerateWP is installed | - -Parameters can be used to determine the billing account of the user in order to display proper page. -WHMCS plugin already has automatic redirect to upgrade page, there is only needed to set upgrade-url -to the root of your WHMCS instance. - -``` -cloudlinux-awp-admin set-options --upgrade-url https://whmcs.mydomain.zone/ -``` - -Upgrade URL is opened in modal browser window and will be automatically closed -when AccelerateWP receives callback about successful upgrade. - -Callback is already implemented in WHMCS plugin, but if you are using some other billing, -you should add the following code on the page which appears when user successfully upgrades subscription. - - - - -In order to remove the link, just set upgrade url to the empty one. - -``` -cloudlinux-awp-admin set-options --upgrade-url '' -``` - -### Disable AccelerateWP Premium - -If you would like to stop using AccelerateWP Premium, -click on the `manage` link and remove `Premium Features` checkbox. -AccelerateWP will be still available for your users. - -![](/images/solo/manager/awp/AWPDisablePremiumOnly.webp) - -### Disable AccelerateWP - -If you would like to stop using AccelerateWP completely, toggle the `AccelerateWP` back. -Both AccelerateWP and AccelerateWP Premium will be turned off. - -![](/images/solo/manager/awp/AWPDisable.webp) - -This operation will: -* disable AccelerateWP tab in users' control panel interface -* disable all AccelerateWP optimization suites -* deactivate all optimization features for all users - -This operation will NOT: -* cancel the subscription made by user in WHMCS or other billing. User's subscription stays - alive and user will still be charged in billing system unless hoster manually makes a refund - - -### Logs -The main AccelerateWP log is located at -* `/var/log/clwpos/main.log` - - -In case if AccelerateWP Premium is active, the auxiliary monitoring daemon `clwpos_monitoring` is also activated. Its log is located at -* `/var/log/clwpos/daemon.log` - - -### FAQ - -#### With which panel can I use AccelerateWP? - -Currently AccelerateWP is compatible with cPanel, Plesk, and DirectAdmin only. - -#### Is it possible to use AccelerateWP on a non-control panel server? -Yes, if a custom integration mechanism is used: [custom control panel integration](https://blog.cloudlinux.com/acceleratewp-is-now-supporting-custom-control-panel-integration). - - -#### Do you plan to enable support of Nginx server? -This is a part of our very long term plans, thus not expected in the nearest future. - -#### How will it help my customers? -AccelerateWP is a complex solution to help your customers increase their WordPress site performance. AccelerateWP brings number of optimization features, like object caching, css and js preprocessing and website preloading. - -#### How could I monitor Redis instances while using AccelerateWP Premium suite? -Redis process is started for a user after activating AccelerateWP Premium Object Caching feature for at least one Wordpress site. -It is killed after AccelerateWP Premium Object Caching has been deactivated for all user's websites. - -Look through the processes list to check Redis status for a particular user: -``` - ps aux | grep redis - - awpuser 2662517 0.0 0.5 101096 8512 ? Sl 15:33 0:00 /opt/alt/redis/bin/redis-server unixsocket:/home/awpuser/.clwpos/redis.sock -``` -In case if AccelerateWP Premium is active, the auxiliary monitoring daemon `clwpos_monitoring` is also activated. It checks Redis instances each 5 minutes, starts new instances, restart failed ones and kills the “garbage” instances if needed. -Check daemon status using `service clwpos_monitoring status` and its main log: `/var/log/clwpos/daemon.log`. - - -### Troubleshooting - -#### My users are complaining that their feature are not installed automatically after subscription upgrade -This can be caused by several reasons. Either your customer's website was detected to have malfunctions -or there was an issue with environment when feature was installed -(e.g. bad internet connectivity with wordpress market). - -First, try to enable feature manually using AccelerateWP interface. -Most likely you will find human-readable error message there. - -Next, you can try to dive into `/var/log/clwpos/daemon.log` and find the reason why the `enable` command failed. -Here is an example of successful feature installation for reference: - - - 2023-02-14 11:01:14,696: (clwpos.daemon_base) [INFO] Running cloudlinux-awp-user enable --feature object_cache --domain wpujj.com --wp-path - 2023-02-14 11:01:15,081: (clwpos.daemon_base) [INFO] Command succeded with output: - `CompletedProcess(args=['/bin/cagefs_enter.proxied', 'cloudlinux-awp-user', 'enable', '--feature', 'object_cache', '--domain', 'wpujj.com', '--wp-path', ''], returncode=0, stdout='{\n "context": {\n "domain": "wpujj.com",\n "feature": "object_cache"\n },\n "result": "success",\n "timestamp": 1676372475.044419,\n \n}\n', stderr='')` - 2023-02-14 11:01:15,086: (clwpos.daemon_base) [INFO] background process finished: pid=415368 - -Also, some useful notes may be present in user's log located at `/home//.clwpos/main.log`. - -If the issue persists, or you cannot resolve it yourself, -contact CloudLinux support and attach `/var/log/clwpos/daemon.log` and `/home//.clwpos/main.log` -for further investigation. - -#### End-users of AccelerateWP Premium feature encounter Redis extension is not installed for selected php version -In order to make use of AccelerateWP Premium Object Caching feature, the loaded Redis extension is required for the end-user's website. -End-users will not be able to activate the Object Caching feature until Redis extension configuration is incomplete. - -Corresponding incompatibility warning will be displayed in control panel's User interface: - -![](/images/solo/manager/awp/AWPNoRedis.webp) - -The Redis extensions are configured for all installed and supported PHP versions automatically: -* right after the AccelerateWP Premium suite is enabled -* by cron once a day - -or you can trigger the utility manually: -``` -/usr/sbin/enable_redis_for_panel_php -``` - -All errors will be displayed in standard output and logged into `/var/log/clwpos/main.log`. - - -**Ensuring the EA-PHP Redis extension is configured correctly** - -1. Check Redis extension package is installed by running the following command - - ``` - rpm -q ea-phpXY-php-redis - ``` - Install the corresponding extension if it is not present: - ``` - yum install ea-phpXY-php-redis - ``` - Consider the example for checking out and installing Redis extension for `ea-php74`: - ``` - rpm -q ea-php74-php-redis - yum install ea-php74-php-redis - ``` -2. Check Redis `ini` file is present by running the following command: - ``` - ls /opt/cpanel/ea-phpXY/root/etc/php.d/ | grep 50-redis - ``` - Consider the example for checking out Redis extension for `ea-php74`: - ``` - ls /opt/cpanel/ea-php74/root/etc/php.d/ | grep 50-redis - ``` - Try reinstalling the package if `ini` file is missing. -3. Make sure Redis module is loaded under specific user by running the following command: - ``` - su -c "php -m | grep redis" - ``` - - -**Ensuring the ALT-PHP Redis extension is configured correctly** - -1. Check if `redis.so` is present for a particular alt-php version: - ``` - ls /opt/alt/phpXY/usr/lib64/php/modules | grep redis.so - ``` - Consider the example for checking alt-php74 redis.so: - ``` - ls /opt/alt/php74/usr/lib64/php/modules | grep redis.so - redis.so - ``` -2. If the Redis module is missing: - - a. Install the `alt-phpXY-pecl-ext` package manually - b. Run the Redis configuration script `/usr/share/cloudlinux/wpos/enable_redis_for_alt_php.py` - - All errors will be displayed in standard output and logged into `/var/log/clwpos/main.log`. -3. If the Redis module is present for a particular php version, but the incompatibility issue persists, re-check the following: - - a. Make sure the Redis module is loaded under user: - ``` - su -c "php -m | grep redis" - ``` - b. Check the required extensions are enabled in `php.ini`: - ``` - cat /opt/alt/phpXY/etc/php.ini | grep redis.so - cat /opt/alt/phpXY/etc/php.ini | grep json.so - cat /opt/alt/phpXY/etc/php.ini | grep igbinary.so - ``` - - c. Enable missing extensions manually. - - -#### End-users of AccelerateWP encounter PHP-related issues during feature activation -End-users may encounter PHP-related errors while activating the AccelerateWP features. - -![](/images/solo/manager/awp/AWPBrokenPHP.webp) - -The general examples of possible reasons are: -* broken PHP binaries -* missing PHP files -* etc. - -To check that this issue is caused by PHP itself, call any PHP command, example for cPanel: -``` -/opt/cpanel/ea-php80/root/usr/bin/php -i -``` -And make sure that installed `ea-php80` packages are not broken using -`rpm -V `. - -Reinstall broken packages if found. - -Consider the example issue (presented at the picture above) with broken `mbstring.so` for `ea-php80`: -``` -/opt/cpanel/ea-php80/root/usr/bin/php -i -Segmentation fault (core dumped) - -rpm -V ea-php80 - -rpm -V ea-php80-php-mbstring -S.5....T. /opt/cpanel/ea-php80/root/usr/lib64/php/modules/mbstring.so -......G.. a /usr/lib/.build-id/9c/38ed78a6d401ff6dce059ccea51c95870d98c5 - -yum reinstall ea-php80-php-mbstring -``` - - -### AccelerateWP for End-Users - -Please find the AccelerateWP Suite End-User documentation [here](/user-docs/user-docs-solo-cloudlinux/). - - -## Limits - -Cloudlinux Solo supports only inodes limits. More informormation is available [here](/cloudlinuxos/limits/#inodes) - -## PHP Selector - -* [Overview](/solo/manager/#php-selector-overview) -* [How to enable PHP Selector](/solo/manager/#how-to-enable-php-selector) -* [PHP Handlers](/solo/manager/#php-handlers) -* [Administrator interface](/solo/manager/#administrator-interface-1) - -### Overview - -PHP Selector is a CloudLinux component which allows users to select PHP versions and modules for particular user’s domains. These PHP versions are provided by CloudLinux and in the list there are newest as well as outdated versions. - -### How to enable PHP selector - -PHP selector is available for SOLO starting from these versions: - -``` -liblve-2.1-12 - alt-python27-cllib@3.2.40-1 - lve-wrappers #0.7.8-1 - lve-utils #6.4.6-1 - cagefs #7.5.2-1 - lvemanager #7.8.3-1 -``` - -**To start working with CloudLinux PHP Selector:** - -1. Update packages -``` -yum update lvemanager lve-utils alt-python27-cllib -``` - -2. Open CloudLinux manager -> Selector tab -> Select PHP versions to install. - -![](/images/solo/manager/solo_php_selector_1.webp) - -### PHP Handlers - -#### Compatibility matrix - -|**Web Server**|**PHP Selector**| -|:-:|:-:| -|Apache/suPHP|Yes| -|Apache/FCGID|Yes| -|Apache/CGI|Yes| -|Apache/mod_lsapi|Yes| - -#### How to install Apache modules - -You can use cPanel interface: - -![](/images/solo/manager/solo_php_selector_2.webp) - -### Administrator interface - -In the Selector tab the diagnostic bar help to monitor configuration of PHP Selector - -![](/images/solo/manager/solo_php_selector_3.webp) - -The Main Settings helps to monitor next settings - -![](/images/solo/manager/solo_php_selector_4.webp) - -![](/images/solo/manager/solo_php_selector_5.webp)