cloudflare/Cloudflare-CPanel
Publicmirrored fromhttps://github.com/cloudflare/Cloudflare-CPanel
README
44lines · modecode
15 years ago
| 1 | CloudFlare plugin for CPanel. |
| 2 | |
| 3 | Requires: |
| 4 | |
| 5 | * Net::SSLeay |
| 6 | * Simplezoneedit or Zoneedit features |
| 7 | |
| 8 | Provides access to the CloudFlare service. Learn more about CloudFlare at cloudflare.com. |
| 9 | |
| 10 | First, acquire a host api key from CloudFlare. |
| 11 | |
| 12 | Install (as root): |
| 13 | |
| 14 | ./install_cf HOST_API_KEY [mod_cf] [Provider Name] |
| 15 | |
| 16 | This works for the default theme and locale. Other themes or locales may require custom work. |
| 17 | Replace HOST_API_KEY with your api key. Adding the string mod_cf will also install the Apache |
| 18 | extension mod_cloudflare on the local server. More information is available here: |
| 19 | https://github.com/cloudflare/CloudFlare-Tools. |
| 20 | |
| 21 | Edit API key: |
| 22 | |
| 23 | If you need to, update your API key by editing the file /usr/local/cpanel/etc/cloudflare.json, updating |
| 24 | the value host_key. |
| 25 | |
| 26 | Edit CloudFlare prefix: |
| 27 | |
| 28 | After having been routed through the CloudFlare network, if the traffic is clean and cannot be handled by |
| 29 | the CloudFlare cache, it will be relayed to a single given subdomain. Be default, this is |
| 30 | cloudflare-resolve-to.example.com (replacing example.com with each user's domain). |
| 31 | If you wish to change the subdomain, edit the file /usr/local/cpanel/etc/cloudflare.json, |
| 32 | changing the value of the host_prefix key to the desired subdomain. This subdomain will be |
| 33 | automatically added to each user's zone file. |
| 34 | |
| 35 | Uninstall: |
| 36 | |
| 37 | /usr/local/cpanel/bin/unregister_cpanelplugin <full path to install file cloudflare.cpanelplugin> |
| 38 | |
| 39 | Customization: |
| 40 | |
| 41 | To include customized text, edit the file /usr/local/cpanel/etc/cloudflare_local.tmpl. This file is included in CloudFlare's HTML template. |
| 42 | |
| 43 | Copyright (c) 2011 by CloudFlare, Inc. |
| 44 | All Rights Reserved. |