{"id":804,"date":"2021-07-23T12:38:33","date_gmt":"2021-07-23T12:38:33","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/php-fpm-domain-pools\/"},"modified":"2021-07-23T12:38:33","modified_gmt":"2021-07-23T12:38:33","slug":"php-fpm-domain-pools","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/php-fpm-domain-pools\/","title":{"rendered":"PHP-FPM Domain Pools"},"content":{"rendered":"<\/p>\n
\n
<\/div>\n
\n

Overview<\/h2>\n

This document explains how the system creates a domain pool with PHP-FPM.<\/p>\n

How does the system create pools?<\/h2>\n

The system creates a pool when the \/var\/cpanel\/userdata\/[user]\/[domain].php_fpm.yaml<\/code> configuration file exists in the domain. This file must<\/strong> include the following lines:<\/p>\n

\n
\n\n\n
\n
1\n<\/span>2\n<\/span><\/code><\/pre>\n<\/td>\n
\n
---<\/span>\n_is_present<\/span>: 1<\/span><\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
You may place any desired pool values in this file.<\/p>\n
    \n
  • You must<\/strong> include the ---<\/code> line above the pool values in this file.<\/li>\n
  • The _is_present<\/code> value is optional, but you must<\/strong> include it if you do not set any other values in the file.<\/li>\n<\/ul>\n
    \n
    Warning:<\/div>\n
    \n        Exercise extreme<\/strong> caution when you manually edit .yaml<\/code> files. Incorrect syntax in these files will cause services to fail. We strongly<\/strong> recommend that you create a backup of your system before you manually edit .yaml<\/code> files.\n    <\/div>\n<\/div>\n
    \n
    Note:<\/div>\n
    \n        This file only<\/strong> contains the differences of directives from the built-in default directives.\n    <\/div>\n<\/div>\n
    Create a pool<\/h3>\n
    To create a pool, run the Cpanel::PHPFPM::rebuild_files()<\/code> function.<\/p>\n
    \n
    Note:<\/div>\n
    \n        You may also run the \/scripts\/php_fpm_config --rebuild<\/code> script to create a pool.\n    <\/div>\n<\/div>\n
    The system will perform the following steps:<\/p>\n
      \n
    • \n
      The system scans for the \/var\/cpanel\/ApachePHPFPM\/system.yaml<\/code> and \/var\/cpanel\/ApachePHPFPM\/system_pool_defaults.yaml<\/code> files and then generates a system configuration for each of the PHP versions.<\/p>\n<\/li>\n
    • \n
      The system searches for the domain\u2019s yaml<\/code> files.<\/p>\n<\/li>\n
    • \n
      The system generates a line in the \/opt\/cpanel\/[ea_php_version]\/root\/etc\/php-fpm.d\/[domain].conf<\/code> file for every domain.yaml<\/code> file.<\/p>\n<\/li>\n
    • \n
      To direct the requests to the php_fpm<\/code> daemon with Apache, the system modifies the httpd.conf<\/code> file with the rebuild_files()<\/code> script to resemble the following example:<\/p>\n<\/li>\n<\/ul>\n
      \n
      \n\n\n
      \n
      1\n<\/span>2\n<\/span>3\n<\/span>4\n<\/span>5\n<\/span><\/code><\/pre>\n<\/td>\n
      		\n
      # php -- BEGIN cPanel-generated handler, do not edit\n<FilesMatch<\/span> \".(<\/span>phtml<\/span>|<\/span>php<\/span>[<\/span>0-9<\/span>]*)$\"<\/span>>\n    SetHandler \"proxy:unix:\/home\/cptest3\/cptest3_tld.php_fpm.sock|fcgi:\/\/cptest3.tld\/\"\n<\/FilesMatch<\/span>>\n# php -- END cPanel-generated handler, do not edit<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
      \n
      Note:<\/div>\n
      \n
      The system removes any existing conf<\/code> files that do not contain a corresponding domain.yaml<\/code> file.<\/p>\n<\/p><\/div>\n<\/div>\n
      The system creates the FPM socket in the \/opt\/cpanel\/phpversion\/root\/usr\/var\/run\/php-fpm\/obscure_domain.sock<\/code> directory, where phpversion<\/code> represents the version of PHP, and obscure_domain<\/code> represents a hashed version of the domain. Your hashed version will resemble the following example:<\/p>\n
      \/opt\/cpanel\/ea-php56\/root\/usr\/var\/run\/php-fpm\/4cfb2f15c04ae8a6a980ad6b78a834e7c8661958.sock\n<\/code><\/pre>\n
      When the pool and system configurations exist in their designated locations, the system restarts the pools. The method that the system uses to restart them depends on whether it runs as a systemd<\/code> or an init.d<\/code> system. The system then removes any PHP version pools that do not<\/strong> hold domains with that version.<\/p>\n
      Jail shell<\/h2>\n
      When you create a PHP-FPM domain pool, if the following conditions exist, the system automatically binds them to the virtfs<\/code> mount:<\/p>\n
        \n
      • The \/var\/cpanel\/feature_toggles\/apachefpmjail<\/code> file exists.<\/li>\n
      • The WHM account uses either the jailshell<\/code> or noshell<\/code> settings.<\/li>\n
      • You enabled the _Experimental: Jail Apache Virtual Hosts using modruid2 and cPanel\u00ae jailshell<\/em> setting in the Security<\/em> section of WHM\u2019s  Tweak Settings<\/em>  interface (WHM >> Home >> Server Configuration >> Tweak Settings<\/em>).<\/li>\n<\/ul><\/div>\n","protected":false},"excerpt":{"rendered":"
        Overview This document explains how the system creates a domain pool with PHP-FPM. How does the system create pools? The system creates a pool when the \/var\/cpanel\/userdata\/[user]\/[domain].php_fpm.yaml configuration file exists in the domain. This file must include the following lines: 1 2 — _is_present: 1 You may place any desired pool values in this file. …<\/p>\n","protected":false},"author":1,"featured_media":805,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/804"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=804"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/804\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/805"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=804"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=804"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=804"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}