Provides a CPanel Plugin to allow one click Cloudflare setup.
PHP JavaScript Shell CSS Perl
Latest commit 5275007 Feb 20, 2017 @jwineman jwineman committed on GitHub Merge pull request #126 from cloudflare/jwineman/GH-125
GH-125: Removing from
Failed to load latest commit information.
assets PI-793 updated logo Oct 5, 2016
cloudflare v6.0.0 Apr 28, 2016
fonts v6.0.0 Apr 28, 2016
git-hooks PI-756: Simplifying pre-push logic. Aug 25, 2016
installers v6.0.0 Apr 28, 2016
lang DES-965 updated compiled.js cloudflare-frontend 2.6.0 Nov 4, 2016
src PI-873 added tests for mergeDNSRecords Oct 27, 2016
stylesheets PI-941: compiled.js to db8ce9b90256f039c65ed3e1a35e7977b2fcca41. Jan 31, 2017
vendor PI-996 update vendor folder Feb 3, 2017
.gitignore PI-793 updated logo Oct 5, 2016
APIKey v6.0.0 Apr 28, 2016 Release v6.1.2 Jan 31, 2017 Removing extra semi-colon in Apr 29, 2016 PI-863 Renamed strings from "CloudFlare" to "Cloudflare" Oct 13, 2016 Updaing localization instructions. Nov 15, 2016 GH-125: Removing from Feb 19, 2017 Fix case of the word Cloudflare Jan 5, 2017 PI-750: Fixing to be correctly permissioned. Aug 26, 2016
compiled.js PI-941: compiled.js to db8ce9b90256f039c65ed3e1a35e7977b2fcca41. Jan 31, 2017
composer.json PI-996 add guzzle 3.x to composer.json Feb 3, 2017
composer.lock PI-996 add guzzle 3.x to composer.json Feb 3, 2017
config.js Release v6.1.2 Jan 31, 2017 PI-863 removed unused css files Nov 28, 2016
phpunit.xml v6.0.0 Apr 28, 2016 PI-721 fixed CSRF Token error message Aug 17, 2016 PI-721 update Aug 15, 2016

Cloudflare cPanel Quick Installation Instructions

Using an SSH client such as Terminal or Putty:

Step 1. Access cPanel for the server using root user by:


Step 2. Download necessary files and run installation

bash <(curl -s -k [YOUR_HOST_API_KEY] -n '[YOUR_COMPANY_NAME]'


  • Be sure to replace [YOUR_HOST_API_KEY] and [YOUR_COMPANY_NAME] with the appropriate values

cPanel X3 Theme Support Deprecated

We deprecated support for the cPanel X3 theme because the theme itself is deprecated and scheduled for removal in a future version of cPanel. We realize everyone may not be able to deprecate support for the x3 theme immedietely and have made the old v5 version of the plugin available on the v5 branch. This deprecated branch will not receive any updates aside from security fixes.


The English localization will always be up to date and is located at config/en.js. In the future we plan to support more languages by default but if you would like to localize the plugin in your language in the mean time follow these steps:

  1. Copy lang/en.js as lang/[LANGUAGE CODE].js and translate it.
  2. Edit config.js and set "locale": "[LANGUAGE CODE]" using the same language code from step 1.

Full Zone Provisioning

The plugin now supports Full Zone Provisioning but it is disabled by default. If you would like to enable it for your customers simple edit config.js so that "featureManagerIsFullZoneProvisioningEnabled": true,

Uninstalling the cPanel Plugin

An uninstall script has been provided to unregister the plugin with cPanel and remove all Cloudflare specific files from the server to deactivate the plugin.

NOTE: This will not remove zones or users from Cloudflare that have been registered through the plugin.

The following set of commands will download the necessary files, execute the uninstall script and ultimately remove the uninstall script as well:

bash <(curl -s && rm -f