Provides a CPanel Plugin to allow one click Cloudflare setup.
PHP JavaScript Shell CSS Perl
Clone or download
Latest commit fb1c47c Feb 21, 2018
Permalink
Failed to load latest commit information.
assets PI-1200: Updated lang/en.js, assets. Jul 17, 2017
fonts v6.0.0 Apr 28, 2016
installers PI-1046 fixed the positioning of the sag Mar 15, 2017
lang PI-1200: Updated lang/en.js, assets. Jul 17, 2017
src PI-1207: Updating SSL Verification test to assert the DNS record look… Jul 19, 2017
stylesheets PI-941: compiled.js to db8ce9b90256f039c65ed3e1a35e7977b2fcca41. Jan 31, 2017
vendor Updated cloudflare-plugin-backend Jul 14, 2017
.gitignore PI-793 updated logo Oct 5, 2016
.travis.yml Added .travis.yml Mar 2, 2017
APIKey Refactor get_host_api_key function to use CamelCase Jun 22, 2017
CHANGELOG.md Release v7.0.1 Feb 21, 2018
CONTRIBUTING.md PI-1236 Fix install issue for new users Aug 30, 2017
CloudFlare.pm Refactor get_host_api_key function to use CamelCase Jun 22, 2017
LICENSE.md PI-863 Renamed strings from "CloudFlare" to "Cloudflare" Oct 13, 2016
README.md PI-1236 Fix install issue for new users Aug 30, 2017
cloudflare.install.sh Implemented getConfig and updated related files Jul 14, 2017
cloudflare.uninstall.sh Fix case of the word Cloudflare Jan 5, 2017
cloudflare_simple.tar.bz2 PP-368 updated branding Mar 3, 2017
cloudflare_update.sh PI-1236 Fix install issue for new users Aug 30, 2017
compiled.js PI-1200 Updated compiled.js to use v3.0.0 Jul 17, 2017
composer.json Release v7.0.1 Feb 21, 2018
composer.lock Updated cloudflare-plugin-backend Jul 14, 2017
config.json.sample PI-1200 Blacklisted some keys Jul 14, 2017
index.live.php Some formatting thing Jul 14, 2017
phpunit.xml v6.0.0 Apr 28, 2016
proxy.live.php PI-1032: cloudflare/cloudflare-plugin-backend to 2.0.0 to fix bug in … Mar 8, 2017
sync.sh Implemented getConfig and updated related files Jul 14, 2017

README.md

Build Status

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. Rename config.json.sample to config.json.
  3. Edit config.json 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.json 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