Skip to content

Commit d86ad0f

Browse files
authored
Update docs (#315)
* Prefix titles and files with oidc * Remove image
1 parent 0221327 commit d86ad0f

File tree

7 files changed

+18
-20
lines changed

7 files changed

+18
-20
lines changed

docs/configuration.md renamed to docs/oidc-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configuration
1+
# OIDC Module - Configuration
22

33
This guide summarizes key configuration topics for the OIDC module.
44
It complements the inline comments in `config/module_oidc.php`.

docs/conformance.md renamed to docs/oidc-conformance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OpenID Conformance
1+
# OIDC Module - OpenID Conformance
22

33
This guide summarizes how to run the OpenID Foundation conformance tests
44
against this module, both locally and using the hosted service.

docs/docker.md renamed to docs/oidc-docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Using Docker
1+
# OIDC Module - Using Docker
22

33
This document shows how to run and test the module with Docker.
44

@@ -115,7 +115,7 @@ docker exec ssp-oidc-dev-image sqlite3 /var/simplesamlphp/data/mydb.sq3 '.dump'
115115
> docker/conformance.sql
116116
```
117117

118-
Conformance tests are easier to run locally. See [Conformance](conformance.md).
118+
Conformance tests are easier to run locally. See [Conformance](oidc-conformance.md).
119119

120120
## Docker Compose
121121

docs/faq.md renamed to docs/oidc-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# FAQ
1+
# OIDC Module - FAQ
22

33
A few common questions gathered from prior discussions.
44

docs/installation.md renamed to docs/oidc-installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installation
1+
# OIDC Module - Installation
22

33
This guide walks you through installing, enabling, and preparing the OIDC
44
module in SimpleSAMLphp.
@@ -106,6 +106,6 @@ php modules/oidc/bin/install.php
106106
## 7. Next steps
107107

108108
- Configure caches, endpoints, and other options:
109-
see [Configuration](configuration.md)
109+
see [Configuration](oidc-configuration.md)
110110
- Administer clients from the UI:
111-
see [Relying Party (RP) Administration](configuration.md#relying-party-rp-administration)
111+
see [Relying Party (RP) Administration](oidc-configuration.md#relying-party-rp-administration)

docs/upgrade.md renamed to docs/oidc-upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Upgrade guide
1+
# OIDC Module - Upgrade guide
22

33
This is an upgrade guide from versions 1 → 6. Review the changes and
44
apply those relevant to your deployment.

docs/oidc.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ Supported flows:
1111
- Implicit (response_type: `id_token token` or `id_token`)
1212
- Refresh Token
1313

14-
![Main screen capture](oidc.png)
15-
1614
## Note on OpenID Federation (OIDFed)
1715

1816
OpenID Federation support is in draft, as is the
@@ -47,16 +45,16 @@ any v2.\* of SimpleSAMLphp. PHP version requirements may differ.
4745
| v3.\* | v2.0.\* | \>=7.4 | |
4846
| v2.\* | v1.19.\* | \>=7.4 | |
4947

50-
Upgrading? See the [upgrade guide](upgrade.md).
48+
Upgrading? See the [upgrade guide](oidc-upgrade.md).
5149

5250
## Documentation
5351

54-
- Getting started: [Installation](installation.md)
55-
- Configure and operate: [Configuration](configuration.md)
56-
- Manage clients and UI: see [Configuration](configuration.md#relying-party-rp-administration)
52+
- Getting started: [Installation](oidc-installation.md)
53+
- Configure and operate: [Configuration](oidc-configuration.md)
54+
- Manage clients and UI: see [Configuration](oidc-configuration.md#relying-party-rp-administration)
5755
- Endpoints and discovery: see
58-
[Configuration](configuration.md#endpoint-locations-and-well-known-urls)
59-
- Running with containers: [Using Docker](docker.md)
60-
- Conformance tests: [OpenID Conformance](conformance.md)
61-
- Upgrading between versions: [Upgrade guide](upgrade.md)
62-
- Common questions: [FAQ](faq.md)
56+
[Configuration](oidc-configuration.md#endpoint-locations-and-well-known-urls)
57+
- Running with containers: [Using Docker](oidc-docker.md)
58+
- Conformance tests: [OpenID Conformance](oidc-conformance.md)
59+
- Upgrading between versions: [Upgrade guide](oidc-upgrade.md)
60+
- Common questions: [FAQ](oidc-faq.md)

0 commit comments

Comments
 (0)