Skip to content

Commit

Permalink
Merge pull request #124 from creative-commoners/pulls/3.0/cms5-readme
Browse files Browse the repository at this point in the history
DOC Update README.md for CMS 5
  • Loading branch information
sabina-talipova authored Apr 21, 2023
2 parents 272e17e + 1e41ed2 commit b86eb8d
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,36 @@
## About this module
This module includes core configuration that integrates a Silverstripe CMS project with the underlying infrastructure of Silverstripe Cloud Platform CCL (formally Revera). Most NZ public sector projects will have this module included after installing the [silverstripe/recipe-ccl recipe module](https://github.com/silverstripe/recipe-ccl).

### Configuration
## Installation

```sh
composer require cwp/cwp-core
```

## Configuration
There are some settings that can be modified in this module, depending on requirements. These are listed below.

#### XSS Protection
### XSS Protection
By default, sites using this module instruct newer browsers to protect against cross-site scripting (XSS) attacks. This is done using an HTTP header (X-XSS-Protection). More information on this header can be found on the [Mozilla Developer Network](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) site. To disable this feature, add the following to your YML configuration:
```

```yaml
CWP\Core\Control\InitialisationMiddleware:
xss_protection_enabled: false
```
#### Egress Proxy settings
### Egress Proxy settings
An egress proxy is enabled for all external requests made by Silverstripe CMS sites running on Silverstripe Cloud CCL. This means that by default, all HTTP requests made using `curl` or PHP's stream functions are routed via a proxy. In some cases this may not be desired (e.g. if you wish to communicate with localhost). By default, there are two exceptions to this proxy: `services.cwp.govt.nz` and `localhost`. These cover all standard platform use cases (e.g. searching via Solr).

You can disable the egress proxy entirely by adding the following YML configuration:
```

```yaml
CWP\Core\Control\InitialisationMiddleware:
egress_proxy_default_enabled: false
```

You can also add to the list of domains to disable the proxy by adding the following YML configuration:
```

```yaml
CWP\Core\Control\InitialisationMiddleware:
egress_proxy_exclude_domains:
- example.com
Expand Down

0 comments on commit b86eb8d

Please sign in to comment.