README

Connecting WordPress with Cloudflare firewall, protect your WordPress site at DNS level. Automatically create firewall rules to block dangerous IPs

Installation Instructions
- Via Manually Upload
- Via WP CLI
Developing
Build from Source
Branches
- Master
- Nightly
Support!
Running the Tests
Feedback
Change log
Security
Contributing
Credits
License

This repository is a development version of WP Cloudflare Guard intended to facilitate communication with developers. It is not stable and not intended for installation on production sites.

Bug reports and pull requests are welcome.

If you are not a developer or you'd like to receive the stable release version and automatic updates, install it via WordPress.org instead.

Installation Instructions

If you are not a developer or you'd like to receive the stable release version and automatic updates, install it via WordPress.org instead.

The master branch is not installable. Use the nightly branch instead. See branches.

Via Manually Upload

Download the built archive from nightly branch
Unzip it
Upload it to wp-content/plugins/
Go to the WordPress plugin menu and activate it

Via WP CLI

$ wp plugin install https://github.com/TypistTech/wp-cloudflare-guard/archive/nightly.zip --activate

Developing

Before start hacking, you need composer and yarn installed. See:

To setup a developer workable version you should run these commands:

$ composer create-project --keep-vcs --no-install typisttech/wp-cloudflare-guard:dev-master
$ cd wp-cloudflare-guard
$ composer install

Build from Source

These commands build the plugin into release/wp-cloudflare-guard.zip.

$ composer build
release/wp-cloudflare-guard.zip

Branches

Master

The master branch is the main branch where the source code of HEAD always reflects a state with the latest delivered development changes for the next release. This is where the nightly branch is built from. Since we built this plugin with composer and grunt, this branch is not installable.

Nightly

The nightly branch is built by TravisCI whenever the master branch is updated. Anything in the nightly branch is installable. See installation instructions.

Support!

Donate via PayPal

Love WP Cloudflare Guard? Help me maintain WP Cloudflare Guard, a donation here can help with it.

Why don't you hire me?

Ready to take freelance WordPress jobs. Contact me via the contact form here or, via email info@typist.tech

Want to help in other way? Want to be a sponsor?

Contact: Tang Rufus

Running the Tests

WP Cloudflare Guard run tests on Codeception and relies wp-browser to provide WordPress integration. Before testing, you have to install WordPress locally and add a codeception.yml file.

See codeception.example.yml for a Varying Vagrant Vagrants configuration example.

Actually run the tests:

$ composer test

We also test all PHP files against PSR-2: Coding Style Guide and part of the WordPress coding standard.

Check the code style with $ composer check-style and fix it with $ composer fix-style.

Feedback

Please provide feedback! We want to make this library useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small.

Change log

Please see CHANGELOG for more information on what has changed recently.

Security

If you discover any security related issues, please email wp-cloudflare-guard@typist.tech instead of using the issue tracker.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Credits

WP Cloudflare Guard is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire.

Full list of contributors can be found here.

License

WP Cloudflare Guard is licensed under the GPLv2 (or later) from the Free Software Foundation. Please see License File for more information.

typisttech / wp-cloudflare-guard

Maintainers

Details