Skip to content

Commit 86cef7d

Browse files
committed
docs: prefer the new way of enabling modules for exampleauth.
closes: #1477
1 parent 64fca25 commit 86cef7d

2 files changed

Lines changed: 17 additions & 10 deletions

File tree

docs/simplesamlphp-googleapps.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,15 @@ After you have successfuly tested that everything is working with the simple `ex
8989
Configuring the authentication source
9090
-------------------------------------
9191

92-
The `exampleauth:UserPass` authentication source is part of the `exampleauth` module. This module isn't enabled by default, so you will have to enable it. This is done by creating a file named `enable` in `modules/exampleauth/`.
93-
94-
On unix, this can be done by running (from the SimpleSAMLphp installation directory):
95-
96-
touch modules/exampleauth/enable
92+
The `exampleauth:UserPass` authentication module is part of the `exampleauth` module. This module isn't enabled by default, so you will have to enable it. In
93+
`config.php`, search for the `module.enable` key and set `exampleauth` to true:
94+
95+
```
96+
'module.enable' => [
97+
'exampleauth' => true,
98+
99+
],
100+
```
97101

98102
The next step is to create an authentication source with this module. An authentication source is an authentication module with a specific configuration. Each authentication source has a name, which is used to refer to this specific configuration in the IdP configuration. Configuration for authentication sources can be found in `config/authsources.php`.
99103

docs/simplesamlphp-idp.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,15 @@ In this guide, we will use the `exampleauth:UserPass` authentication module. Thi
8484
Configuring the authentication module
8585
-------------------------------------
8686

87-
The `exampleauth:UserPass` authentication module is part of the `exampleauth` module. This module isn't enabled by default, so you will have to enable it. This is done by creating a file named `enable` in `modules/exampleauth/`.
87+
The `exampleauth:UserPass` authentication module is part of the `exampleauth` module. This module isn't enabled by default, so you will have to enable it. In
88+
`config.php`, search for the `module.enable` key and set `exampleauth` to true:
8889

89-
On unix, this can be done by running (from the SimpleSAMLphp
90-
installation directory):
91-
92-
touch modules/exampleauth/enable
90+
```
91+
'module.enable' => [
92+
'exampleauth' => true,
93+
94+
],
95+
```
9396

9497
The next step is to create an authentication source with this module. An authentication source is an authentication module with a specific configuration. Each authentication source has a name, which is used to refer to this specific configuration in the IdP configuration. Configuration for authentication sources can be found in `config/authsources.php`.
9598

0 commit comments

Comments
 (0)