diff --git a/docs/configuration.md b/docs/oidc-configuration.md similarity index 96% rename from docs/configuration.md rename to docs/oidc-configuration.md index 3e3084dd..12ad22c7 100644 --- a/docs/configuration.md +++ b/docs/oidc-configuration.md @@ -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`. diff --git a/docs/conformance.md b/docs/oidc-conformance.md similarity index 96% rename from docs/conformance.md rename to docs/oidc-conformance.md index 81863b15..f651cf54 100644 --- a/docs/conformance.md +++ b/docs/oidc-conformance.md @@ -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. diff --git a/docs/docker.md b/docs/oidc-docker.md similarity index 94% rename from docs/docker.md rename to docs/oidc-docker.md index f4923681..2e92d4a5 100644 --- a/docs/docker.md +++ b/docs/oidc-docker.md @@ -1,4 +1,4 @@ -# Using Docker +# OIDC Module - Using Docker This document shows how to run and test the module with Docker. @@ -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 diff --git a/docs/faq.md b/docs/oidc-faq.md similarity index 95% rename from docs/faq.md rename to docs/oidc-faq.md index 5766dadc..ed43b1d5 100644 --- a/docs/faq.md +++ b/docs/oidc-faq.md @@ -1,4 +1,4 @@ -# FAQ +# OIDC Module - FAQ A few common questions gathered from prior discussions. diff --git a/docs/installation.md b/docs/oidc-installation.md similarity index 90% rename from docs/installation.md rename to docs/oidc-installation.md index 50131b77..9ced1ff1 100644 --- a/docs/installation.md +++ b/docs/oidc-installation.md @@ -1,4 +1,4 @@ -# Installation +# OIDC Module - Installation This guide walks you through installing, enabling, and preparing the OIDC module in SimpleSAMLphp. @@ -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) diff --git a/docs/upgrade.md b/docs/oidc-upgrade.md similarity index 97% rename from docs/upgrade.md rename to docs/oidc-upgrade.md index 65d1d219..434fd522 100644 --- a/docs/upgrade.md +++ b/docs/oidc-upgrade.md @@ -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. diff --git a/docs/oidc.md b/docs/oidc.md index 6b38c22a..a79c425d 100644 --- a/docs/oidc.md +++ b/docs/oidc.md @@ -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 @@ -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)