Skip to content
This repository was archived by the owner on Sep 19, 2022. It is now read-only.

Commit 2a4c254

Browse files
melangervyskocilpavel
authored andcommitted
Update README.md
- describe setup for modes PROXY/SP/IDP - change array notation from `array()` to `[]`
1 parent cc2a5ea commit 2a4c254

File tree

2 files changed

+38
-8
lines changed

2 files changed

+38
-8
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ All notable changes to this project will be documented in this file.
88
#### Fixed
99
- Log info message about successful authentication only after successful authentication to SP
1010
- Correct log message in insertLogin()
11+
- Update README.md
12+
- describe setup for modes PROXY/SP/IDP
13+
- change array notation from `array()` to `[]`
1114

1215
## [v3.1.0]
1316
#### Added

README.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,50 @@ Once you have installed SimpleSAMLphp, installing this module is very simple. Fi
1616
1. Install MySQL Database and create database for statistics and user.
1717
2. For this database run script to create tables. Script is available in config-templates/tables.sql.
1818
3. Copy config-templates/module_statisticsproxy.php to your folder vith config and fill it.
19-
4. Configure IdPAttribute filter from Perun module to get sourceIdPName from IdP metadata:
19+
4. Configure, according to mode
20+
* for mode PROXY, configure IdPAttribute filter from Perun module to get sourceIdPName from IdP metadata:
2021
```
21-
XX => array(
22+
XX => [
2223
'class' => 'perun:IdPAttribute',
23-
'attrMap' => array(
24+
'attrMap' => [
2425
'name:en' => 'sourceIdPName',
25-
),
26-
),
27-
#where XX is priority(for example 30; Must not be used for other modules)
26+
],
27+
],
28+
// where XX is priority (for example 30, must not be used for other modules)
29+
```
30+
* for mode IDP, configure `idpEntityId` and `idpName` in `module_statisticsproxy.php`
31+
```
32+
/*
33+
* EntityId of IdP
34+
* REQUIRED FOR IDP MODE
35+
*/
36+
'idpEntityId' => '',
37+
/*
38+
* Name of IdP
39+
* REQUIRED FOR IDP MODE
40+
*/
41+
'idpName' => '',
42+
```
43+
* for mode SP, configure `spEntityId` and `spName` in `module_statisticsproxy.php`
44+
```
45+
/*
46+
* EntityId of SP
47+
* REQUIRED FOR SP MODE
48+
*/
49+
'spEntityId' => '',
50+
/*
51+
* Name of SP
52+
* REQUIRED FOR SP MODE
53+
*/
54+
'spName' => '',
2855
```
2956
5. Configure proxystatistic filter
3057
```
3158
XX => array(
3259
'class' => 'proxystatistics:statistics',
33-
'config' => array (),
60+
'config' => [],
3461
),
35-
#where XX is priority(for example 50; Must not be used for other modules)
62+
// where XX is priority (for example 50, must not be used for other modules)
3663
```
3764
6. Add to `config.php`:
3865
```

0 commit comments

Comments
 (0)