Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/configuration.md → docs/oidc-configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuration
# OIDC Module - Configuration

This guide summarizes key configuration topics for the OIDC module.
It complements the inline comments in `config/module_oidc.php`.
Expand Down
2 changes: 1 addition & 1 deletion docs/conformance.md → docs/oidc-conformance.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OpenID Conformance
# OIDC Module - OpenID Conformance

This guide summarizes how to run the OpenID Foundation conformance tests
against this module, both locally and using the hosted service.
Expand Down
4 changes: 2 additions & 2 deletions docs/docker.md → docs/oidc-docker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Using Docker
# OIDC Module - Using Docker

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

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

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

## Docker Compose

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md → docs/oidc-faq.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FAQ
# OIDC Module - FAQ

A few common questions gathered from prior discussions.

Expand Down
6 changes: 3 additions & 3 deletions docs/installation.md → docs/oidc-installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installation
# OIDC Module - Installation

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

- Configure caches, endpoints, and other options:
see [Configuration](configuration.md)
see [Configuration](oidc-configuration.md)
- Administer clients from the UI:
see [Relying Party (RP) Administration](configuration.md#relying-party-rp-administration)
see [Relying Party (RP) Administration](oidc-configuration.md#relying-party-rp-administration)
2 changes: 1 addition & 1 deletion docs/upgrade.md → docs/oidc-upgrade.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Upgrade guide
# OIDC Module - Upgrade guide

This is an upgrade guide from versions 1 → 6. Review the changes and
apply those relevant to your deployment.
Expand Down
20 changes: 9 additions & 11 deletions docs/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ Supported flows:
- Implicit (response_type: `id_token token` or `id_token`)
- Refresh Token

![Main screen capture](oidc.png)

## Note on OpenID Federation (OIDFed)

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

Upgrading? See the [upgrade guide](upgrade.md).
Upgrading? See the [upgrade guide](oidc-upgrade.md).

## Documentation

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