Skip to content

Commit

Permalink
Merge pull request #99 from creative-commoners/pulls/5.0/cms5-readme
Browse files Browse the repository at this point in the history
DOC Update README.md for CMS 5
sabina-talipova authored Apr 24, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents 650640a + 964386d commit 93a708f
Showing 1 changed file with 2 additions and 32 deletions.
34 changes: 2 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -11,44 +11,14 @@ identity provider. This module requires extensive setup prior to being utilised
If integration with RealMe is wanted, it is best to get in touch with the RealMe team as early as possible. This can be
accomplished by [getting in touch with the RealMe team](https://www.realme.govt.nz/realme-business/).

## Releases
There are multiple releases of this module. The current stable version is the 4.x line. This is a stable module that
provides `logon` (authentication) and `assert` (identity assertion) capability. The 2.x line can be used for SilverStripe
3.x support. The line 3.x only works with PHP <= 7.1 and is deprecated. The older 0.9.x line is considered end of life and should not be used.

## Support
Support is provided via the GitHub Issues for this module.

The 4.0.0 release has been tested with PHP 7.1, 7.2 and 7.3 for the following integrations:
- MTS Logon
- MTS Assert (XML)
- ITE Logon
- ITE Assert (JSON)

If you encounter any issues please [open a new issue here](https://github.com/silverstripe/silverstripe-realme/issues).

## Requirements
This module doesn't have any specific requirements beyond those required by
[onelogin/php-saml](https://github.com/onelogin/php-saml), the tool used to control
authentication with the RealMe systems. The requirements of php-saml can be found on the [module page](https://github.com/onelogin/php-saml#dependencies)

This module is designed to be run on a [CWP](https://www.cwp.govt.nz/) instance, and there are two sets of installation
instructions - one for use on CWP, and one for generic use.

## Installation

The module is best installed via Composer, by adding the below to your composer.json.

```json
"require": {
"silverstripe/realme": "^4"
},
```sh
composer require silverstripe/realme
```

Or by running `composer require silverstripe/realme ^4` in your project root.

Once installation is completed, configuration is required before this module will work - see below.

## Configuration of RealMe for your application

RealMe provide two testing environments and a production environment for you to integrate with. Access to these

0 comments on commit 93a708f

Please sign in to comment.