andrewandante/womens-refuge-shield

Add the Women's refuge shield to your site

Installs: 1 519

Dependents: 0

Suggesters: 0

Stars: 1

Watchers: 1

Forks: 1

Open Issues: 0

Type:silverstripe-vendormodule

v2.1.1 2019-03-04 13:31 UTC

README

This small module is to help you add the Women's Refuge Shielded Site button to your SilverStripe website.

Usage

This code will help you add the shield to your SilverStripe website.

Select the preferred size in your SiteConfig, and the WomensRefugeShield\ControllerExtension will inject the necessary Javascript and CSS in to your pages.

That's all there is to it.

Installation

Include the shield code with composer require andrewandante/womens-refuge-shield and select your preferred size in the CMS under Settings.

Large tab:

Large tab

Small tab:

Small tab

Alternatively, you can include $WomensRefugeShieldButton anywhere in your template:

Button in the footer

Security

This module does allow Javascript from a third-party source, and as such should be treated with a level of caution. Theoretically, this could change at any time. As a result, a copy of the Javascript has been included in the module, which will be periodically updated when the remote script is.

By default, the module will use the committed version of the Javascript. To authorise the use of the remote version, add the following to your site config:

AndrewAndante\WomensRefugeShield\ControllerExtension:
  use_remote_js: true

We have spoken with the original authors of the script, and it has undergone security testing, in particular with regards to:

  • How well the site meets the objectives of being difficult to detect.
  • How secure the Shielded Site is.
  • Whether the inclusion of the Shielded Site introduces significant risk to sites it is hosted on.

We are satisfied with this review, but each site is different and will have different requirements for you to consider.

Versioning

  • version 1.x is for SilverStripe 3
  • version 2.x is for SilverStripe 4

Options

You can view all the options on the Women's Refuge Shielded Site website.

TODO

  • responsiveness

Special Thanks