Provides a CPanel Plugin to allow one click CloudFlare setup.
PHP JavaScript Shell CSS Perl
Permalink
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 DES-965 added plugins.css for cloudflare-frontend only css classes Nov 4, 2016
vendor composer update Aug 15, 2016
.gitignore PI-793 updated logo Oct 5, 2016
APIKey v6.0.0 Apr 28, 2016
CHANGELOG.md Releasing v6.1.0 Nov 8, 2016
CloudFlare.pm Removing extra semi-colon in CloudFlare.pm Apr 29, 2016
LICENSE.md PI-863 Renamed strings from "CloudFlare" to "Cloudflare" Oct 13, 2016
README.md Updaing README.md localization instructions. Nov 15, 2016
cloudflare.install.sh PI-750: Fixing cloudflare_upate.sh to be correctly permissioned. Aug 26, 2016
cloudflare.uninstall.sh PI-676 changed uninstall script to use dynamic php version Jul 21, 2016
cloudflare_update.sh PI-750: Fixing cloudflare_upate.sh to be correctly permissioned. Aug 26, 2016
compiled.js DES-965 updated compiled.js with production settings Nov 7, 2016
compiled.js.map DES-965 updated compiled.js with production settings Nov 7, 2016
composer.json Releasing v6.1.0 Nov 8, 2016
composer.lock composer update Aug 15, 2016
config.js Releasing v6.1.0 Nov 8, 2016
index.live.php DES-965 Changed CloudFlare to Cloudflare Nov 7, 2016
phpunit.xml v6.0.0 Apr 28, 2016
proxy.live.php PI-721 fixed CSRF Token error message Aug 17, 2016
sync.sh PI-721 update sync.sh Aug 15, 2016

README.md

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:

ssh root@SERVER IP ADDRESS or SERVER NAME

Step 2. Download necessary files and run installation

bash <(curl -s https://raw.githubusercontent.com/cloudflare/CloudFlare-CPanel/master/cloudflare.install.sh) -k [YOUR_HOST_API_KEY] -n '[YOUR_COMPANY_NAME]'

NOTES:

  • 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.

Localization

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 https://raw.githubusercontent.com/cloudflare/CloudFlare-CPanel/master/cloudflare.uninstall.sh) && rm -f cloudflare.uninstall.sh