README

WARNING

This package has been replaced, and is no longer maintained.

What Is CMS CloudFlare?

CMS CloudFlare is a CMS Core plugin that adds a CloudFlare admin module.

CMS CloudFlare was created by, and is maintained by Graham Campbell.
CMS CloudFlare relies on my CMS Core and CloudFlare API packages.
CMS CloudFlare uses Travis CI with Coveralls to check everything is working.
CMS CloudFlare uses Scrutinizer CI and SensioLabsInsight to run additional checks.
CMS CloudFlare uses Composer to load and manage dependencies.
CMS CloudFlare provides a change log, releases, and api docs.
CMS CloudFlare is licensed under the GNU AGPLv3, available here.

System Requirements

PHP 5.4.7+ or PHP 5.5+ is required.
You will need a CMS Core application like Bootstrap CMS because this package is designed for it.
You will need Composer installed to load the dependencies of CMS-CloudFlare.

Installation

Please check the system requirements before installing CMS CloudFlare.

To get the latest version of CMS CloudFlare, simply require "graham-campbell/cms-cloudflare": "0.2.*@alpha" in your composer.json file. You'll then need to run composer install or composer update to download it and have the autoloader updated.

You will need to register many service providers before you attempt to load the CMS CloudFlare service provider. Open up app/config/app.php and add the following to the providers key.

'Lightgear\Asset\AssetServiceProvider'
'Cartalyst\Sentry\SentryServiceProvider'
'GrahamCampbell\Core\CoreServiceProvider'
'GrahamCampbell\Viewer\ViewerServiceProvider'
'GrahamCampbell\Queuing\QueuingServiceProvider'
'GrahamCampbell\HTMLMin\HTMLMinServiceProvider'
'GrahamCampbell\Markdown\MarkdownServiceProvider'
'GrahamCampbell\Security\SecurityServiceProvider'
'GrahamCampbell\Binput\BinputServiceProvider'
'GrahamCampbell\Passwd\PasswdServiceProvider'
'GrahamCampbell\Throttle\ThrottleServiceProvider'
'GrahamCampbell\Credentials\CredentialsServiceProvider'
'GrahamCampbell\Navigation\NavigationServiceProvider'
'GrahamCampbell\CMSCore\CMSCoreServiceProvider'
'GrahamCampbell\CoreAPI\CoreAPIServiceProvider'
'GrahamCampbell\CloudFlareAPI\CloudFlareAPIServiceProvider'

Once CMS CloudFlare is installed, you need to register the service provider. Open up app/config/app.php and add the following to the providers key.

'GrahamCampbell\CMSCloudFlare\CMSCloudFlareServiceProvider'

Configuration

CMS CloudFlare requires no configuration. Just follow the simple install instructions and go!

Usage

There is currently no usage documentation besides the API Documentation for CMS CloudFlare.

Updating Your Fork

The latest and greatest source can be found on GitHub.

Before submitting a pull request, you should ensure that your fork is up to date.

You may fork CMS CloudFlare:

git remote add upstream git://github.com/GrahamCampbell/CMS-CloudFlare.git

The first command is only necessary the first time. If you have issues merging, you will need to get a merge tool such as P4Merge.

You can then update the branch:

git pull --rebase upstream master
git push --force origin <branch_name>

Once it is set up, run git mergetool. Once all conflicts are fixed, run git rebase --continue, and git push --force origin <branch_name>.

Pull Requests

Please review these guidelines before submitting any pull requests.

When submitting bug fixes, check if a maintenance branch exists for an older series, then pull against that older branch if the bug is present in it.
Before sending a pull request for a new feature, you should first create an issue with [Proposal] in the title.
Please follow the PSR-2 Coding Style and PHP-FIG Naming Conventions.

License

GNU AFFERO GENERAL PUBLIC LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

graham-campbell / cms-cloudflare

Maintainers

Details