Skip to content

Commit b21e942

Browse files
authored
Update README.md (#215)
extending the documentation with the enabling step
1 parent c42edce commit b21e942

1 file changed

Lines changed: 38 additions & 23 deletions

File tree

README.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -54,28 +54,6 @@ you have at least the following parameters set:
5454
'database.username' => 'user',
5555
'database.password' => 'password',
5656

57-
### Run database migrations
58-
59-
The module comes with some default SQL migrations which set up needed tables in the configured database. To run them,
60-
open the _Federation_ tab from your _SimpleSAMLphp_ installation and select the option _OpenID Connect Installation_
61-
inside the _Tools_ section. Once there, all you need to do is press the _Install_ button and the schema will be created.
62-
63-
Alternatively, in case of automatic / scripted deployments, you can run the 'install.php' script from the command line:
64-
65-
php modules/oidc/bin/install.php
66-
67-
### Relying Party (RP) Administration
68-
69-
The module lets you manage (create, read, update and delete) approved RPs from the module user interface itself.
70-
71-
Once the database schema has been created, you can open the _Federation_ tab from your _SimpleSAMLphp_ installation
72-
and select the option _OpenID Connect Client Registry_ inside the _Tools_ section.
73-
74-
Note that clients can be marked as confidential or public. If the client is not marked as confidential (it is public),
75-
and is using Authorization Code flow, it will have to provide PKCE parameters during the flow.
76-
77-
Client ID and secret will be generated, and can be seen after the client creation by clicking on the 'show' button.
78-
7957
### Create RSA key pair
8058

8159
During the authentication flow, generated ID Token and Access Token will be in a form of signed JSON Web token (JWS).
@@ -99,6 +77,43 @@ or use your passphrase if provided on private key generation:
9977

10078
If you use a passphrase, make sure to also configure it in the `module_oidc.php` config file.
10179

80+
### Enabling the module
81+
82+
At this point we can enable the module by adding `'oidc' => true` to the list of enabled modules in the main simplesamlphp configuration file, `config/config.php`.
83+
84+
'module.enable' => [
85+
'exampleauth' => false,
86+
'core' => true,
87+
'admin' => true,
88+
'saml' => true,
89+
// enable oidc module
90+
'oidc' => true
91+
],
92+
93+
This is required the enable the module on the _Federation_ tab in the admin web interface, which can be used in the next two steps to finalize the installation.
94+
95+
### Run database migrations
96+
97+
The module comes with some default SQL migrations which set up needed tables in the configured database. To run them,
98+
open the _Federation_ tab from your _SimpleSAMLphp_ installation and select the option _OpenID Connect Installation_
99+
inside the _Tools_ section. Once there, all you need to do is press the _Install_ button and the schema will be created.
100+
101+
Alternatively, in case of automatic / scripted deployments, you can run the 'install.php' script from the command line:
102+
103+
php modules/oidc/bin/install.php
104+
105+
### Relying Party (RP) Administration
106+
107+
The module lets you manage (create, read, update and delete) approved RPs from the module user interface itself.
108+
109+
Once the database schema has been created, you can open the _Federation_ tab from your _SimpleSAMLphp_ installation
110+
and select the option _OpenID Connect Client Registry_ inside the _Tools_ section.
111+
112+
Note that clients can be marked as confidential or public. If the client is not marked as confidential (it is public),
113+
and is using Authorization Code flow, it will have to provide PKCE parameters during the flow.
114+
115+
Client ID and secret will be generated, and can be seen after the client creation by clicking on the 'show' button.
116+
102117
### Cron hook
103118

104119
In order to purge expired tokens, this module requires [cron module](https://simplesamlphp.org/docs/stable/cron:cron)
@@ -332,4 +347,4 @@ See [CONFORMANCE_TEST.md](CONFORMANCE_TEST.md)
332347

333348
## Have more questions?
334349

335-
Check the [FAQ](FAQ.md).
350+
Check the [FAQ](FAQ.md).

0 commit comments

Comments
 (0)