Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/typisttech/wp-cloudflare-guard

Connecting WordPress with Cloudflare firewall, protect your WordPress site at DNS level. Automatically create firewall rules to block dangerous IPs
https://github.com/typisttech/wp-cloudflare-guard

cloudflare firewall security wordpress wordpress-plugin

Last synced: 6 days ago
JSON representation

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

Awesome Lists containing this project

README

        

# WP Cloudflare Guard

[![WordPress plugin](https://img.shields.io/wordpress/plugin/v/wp-cloudflare-guard.svg)](https://wordpress.org/plugins/wp-cloudflare-guard/)
[![WordPress](https://img.shields.io/wordpress/plugin/dt/wp-cloudflare-guard.svg)](https://wordpress.org/plugins/wp-cloudflare-guard/)
[![WordPress rating](https://img.shields.io/wordpress/plugin/r/wp-cloudflare-guard.svg)](https://wordpress.org/plugins/wp-cloudflare-guard/)
[![WordPress](https://img.shields.io/wordpress/v/wp-cloudflare-guard.svg)](https://wordpress.org/plugins/wp-cloudflare-guard/)
[![Build Status](https://travis-ci.org/TypistTech/wp-cloudflare-guard.svg?branch=master)](https://travis-ci.org/TypistTech/wp-cloudflare-guard)
[![codecov](https://codecov.io/gh/TypistTech/wp-cloudflare-guard/branch/master/graph/badge.svg)](https://codecov.io/gh/TypistTech/wp-cloudflare-guard)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/TypistTech/wp-cloudflare-guard/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/TypistTech/wp-cloudflare-guard/?branch=master)
[![PHP Versions Tested](http://php-eye.com/badge/typisttech/wp-cloudflare-guard/tested.svg)](https://travis-ci.org/TypistTech/wp-cloudflare-guard)
[![StyleCI](https://styleci.io/repos/83855037/shield?branch=master)](https://styleci.io/repos/83855037)
[![Dependency Status](https://gemnasium.com/badges/github.com/TypistTech/wp-cloudflare-guard.svg)](https://gemnasium.com/github.com/TypistTech/wp-cloudflare-guard)
[![License](https://poser.pugx.org/typisttech/wp-cloudflare-guard/license)](https://packagist.org/packages/typisttech/wp-cloudflare-guard)
[![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.typist.tech/donate/wp-cloudflare-guard/)
[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-ff69b4.svg)](https://www.typist.tech/contact/)

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

- [Installation Instructions](#installation-instructions)
- [Via Manually Upload](#via-manually-upload)
- [Via WP CLI](#via-wp-cli)
- [Developing](#developing)
- [Build from Source](#build-from-source)
- [Branches](#branches)
- [Master](#master)
- [Nightly](#nightly)
- [Support!](#support)
- [Donate via PayPal *](#donate-via-paypal-)
- [Why don't you hire me?](#why-dont-you-hire-me)
- [Want to help in other way? Want to be a sponsor?](#want-to-help-in-other-way-want-to-be-a-sponsor)
- [Running the Tests](#running-the-tests)
- [Feedback](#feedback)
- [Change log](#change-log)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)

This repository is a development version of [WP Cloudflare Guard](https://wordpress.org/plugins/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](https://wordpress.org/plugins/wp-cloudflare-guard/) 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](https://wordpress.org/plugins/wp-cloudflare-guard/) instead.

The `master` branch is not installable. Use the `nightly` branch instead. See [branches](#branches).

### Via Manually Upload

1. Download the built archive from [nightly branch](https://github.com/TypistTech/wp-cloudflare-guard/archive/nightly.zip)

2. Unzip it

3. Upload it to `wp-content/plugins/`

4. Go to the WordPress plugin menu and activate it

### Via WP CLI

1. `$ 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:

- [getcomposer.org](https://getcomposer.org/doc/00-intro.md)
- [yarnpkg.com](https://yarnpkg.com/en/docs/install)

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

```bash
$ 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`.

1. `$ composer build`
2. `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](#installation-instructions).

## Support!

### Donate via PayPal [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.typist.tech/donate/wp-cloudflare-guard/)

Love WP Cloudflare Guard? Help me maintain WP Cloudflare Guard, a [donation here](https://www.typist.tech/donate/wp-cloudflare-guard/) can help with it.

### Why don't you hire me?

Ready to take freelance WordPress jobs. Contact me via the contact form [here](https://www.typist.tech/contact/) or, via email [[email protected]](mailto:[email protected])

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

Contact: [Tang Rufus](mailto:[email protected])

## Running the Tests

[WP Cloudflare Guard](https://github.com/TypistTech/wp-cloudflare-guard) run tests on [Codeception](http://codeception.com/) and relies [wp-browser](https://github.com/lucatume/wp-browser) to provide WordPress integration.
Before testing, you have to install WordPress locally and add a [codeception.yml](http://codeception.com/docs/reference/Configuration) file.

See [codeception.example.yml](codeception.example.yml) for a [Varying Vagrant Vagrants](https://varyingvagrantvagrants.org/) configuration example.

Actually run the tests:

``` bash
$ composer test
```

We also test all PHP files against [PSR-2: Coding Style Guide](http://www.php-fig.org/psr/psr-2/) and part of the [WordPress coding standard](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards).

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](https://github.com/TypistTech/wp-cloudflare-guard/issues/new) 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](CHANGELOG.md) for more information on what has changed recently.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) and [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md) for details.

## Credits

[WP Cloudflare Guard](https://github.com/TypistTech/wp-cloudflare-guard) is a [Typist Tech](https://www.typist.tech) project and maintained by [Tang Rufus](https://twitter.com/Tangrufus), freelance developer for [hire](https://www.typist.tech/contact/).

Full list of contributors can be found [here](https://github.com/TypistTech/wp-cloudflare-guard/graphs/contributors).

## License

[WP Cloudflare Guard](https://github.com/TypistTech/wp-cloudflare-guard) is licensed under the GPLv2 (or later) from the [Free Software Foundation](http://www.fsf.org/).
Please see [License File](LICENSE) for more information.