This OURNAME AAI Proxy installation guide is followed by as set of appapplication/SP-specific guides based on the APPNAME usage with OURNAME AAI Proxy template. They should not overlap.

This a a proposed key content the proxy's README. It could be further extended based on https://wiki.geant.org/pages/viewpage.action?pageId=725614690#SoftwarelicenceselectionandmanagementinG%C3%89ANT-READMEFile, following this structure:

Purpose or intent, which authors may sometimes omit as it may appear self-evident to them.
Scope, supported settings, requirements or constraints of the application which may not be apparent to a reader encountering the project on the intranet.
Installation and configuration.
Usage.
Roadmap and known issues.
Community contributions.
Acknowledgments, dependencies and used tools.
Software licence and licences of differently licensed components.

Keep technical documentation in a separate .md file.

Below are a few related scraps that could be of help:

About AAI Proxy

Overview of AAI Proxy (SAML/OIDC-based) What it serves for.

Features

The offered proxy supports (some ideas about what could be mentioned – check, I do not know where this is from!!!):

SAML2
- HTTP-Redirect binding
- HTTP-POST binding
- Signed responses
- Public URL with metadata in XML
OIDC
- Well-known endpoint
- Authorization endpoint
- Public URL with keys in JWKS
- Token endpoint
  - Optional basic authentication using client secret
- Userinfo endpoint
- Proof Key for Code Exchange (PKCE) - S256
- Standard scopes and corresponding claims (OpenID, email, profile)
- Refresh tokens

Setup

Where is available.

How to install it.

Configuration.

Connecting it to IdP(s).

Capturing SAML or OIDC configuration parameters for providing to the SPs or RPs.

Registration of SPs or RPs with the proxy.

How to check if it works (could be a separate section).

How to check if the SPs or RPs is registered (without using it).

Contributions

Background Info

Implementation notes, descriptions and documentation