Skip to content

Commit 31cffd6

Browse files
committed
Changing licence, adding Drupal 9 support, refactoring README
1 parent 069e23a commit 31cffd6

File tree

3 files changed

+37
-4
lines changed

3 files changed

+37
-4
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# OS2Web SimpleSAML Drupal module [![Build Status](https://travis-ci.org/OS2web/os2web_simplesaml.svg?branch=8.x)](https://travis-ci.org/OS2web/os2web_simplesaml)
22

3-
# Module purpose
3+
## Module purpose
44

55
The aim of this module is to enhance integration with **simplesamlphp_auth** module, by force triggering **SimpleSAML auth page** redirect when certain criteria are met.
66

7-
# How does it work
7+
## How does it work
88

99
Module performs checks on a single redirect triggering page. In order for it to work the cache for anonymous user for that page response is programmatically killed.
1010

@@ -18,7 +18,7 @@ To improve the performance, the redirect decision is stored in cookies to a limi
1818

1919
Additionally module provides a special field for user entity, called **SimpleSAML UID** that allows to create a **SimpleSAML mapping** with the existing Drupal users.
2020

21-
# Additional setings
21+
## Additional setings
2222

2323
- **IP's whitelist**
2424
Comma separate values of IP or IP ranges that will be redirected to SimpleSAML auth page.
@@ -27,3 +27,35 @@ A certain page that triggers the redirect to SimpleSAML auth page if the criteri
2727
- **Cookies TTL**
2828
Stores the redirect response in the cookies for a certain period of time (_defaults: 5min_).
2929

30+
## Install
31+
32+
Module is available to download via composer.
33+
```
34+
composer require os2web/os2web_simplesaml
35+
drush en os2web_simplesaml
36+
```
37+
38+
## Update
39+
Updating process for OS2Web SimpleSAML module is similar to usual Drupal 8 module.
40+
Use Composer's built-in command for listing packages that have updates available:
41+
42+
```
43+
composer outdated os2web/os2web_simplesaml
44+
```
45+
46+
## Automated testing and code quality
47+
See [OS2Web testing and CI information](https://github.com/OS2Web/docs#testing-and-ci)
48+
49+
## Contribution
50+
51+
Project is opened for new features and os course bugfixes.
52+
If you have any suggestion or you found a bug in project, you are very welcome
53+
to create an issue in github repository issue tracker.
54+
For issue description there is expected that you will provide clear and
55+
sufficient information about your feature request or bug report.
56+
57+
### Code review policy
58+
See [OS2Web code review policy](https://github.com/OS2Web/docs#code-review)
59+
60+
### Git name convention
61+
See [OS2Web git name convention](https://github.com/OS2Web/docs#git-guideline)

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "Enhances integration with simplesamlphp_auth module, by force triggering SimpleSAML auth page redirect when certain criteria are met",
55
"minimum-stability": "dev",
66
"prefer-stable": true,
7-
"license": "GPL-2.0+",
7+
"license": "EUPL-1.2",
88
"require": {
99
"drupal/simplesamlphp_auth": "^3.1"
1010
}

os2web_simplesaml.info.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ type: module
33
description: Enhances integration with simplesamlphp_auth module, by force triggering SimpleSAML auth page redirect when certain criteria are met.
44
package: OS2Web
55
core: 8.x
6+
core_version_requirement: ^8 || ^9
67
configure: simplesamlphp_auth.admin_settings_local
78

89
dependencies:

0 commit comments

Comments
 (0)