Skip to content

Commit 199025a

Browse files
peppelinuxc00kiemon5ter
authored andcommitted
Documentation for recently added micro-services
1 parent ad1efcb commit 199025a

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

doc/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,14 @@ To choose which backend (essentially choosing target provider) to use based on t
614614
`DecideBackendByRequester` class which implements that special routing behavior. See the
615615
[example configuration](../example/plugins/microservices/requester_based_routing.yaml.example).
616616

617+
#### Route to a specific backend based on the target entity id
618+
Use the `DecideBackendByTargetIssuer` class which implements that special routing behavior. See the
619+
[example configuration](../example/plugins/microservices/target_based_routing.yaml.example).
620+
621+
If a Discovery Service have been used and the target entity id is selected by users,
622+
also use `DiscoToTargetIssuer` together with `DecideBackendByTargetIssuer`
623+
to get the expected result. See the [example configuration](../example/plugins/microservices/disco_to_target_issuer.yaml.example).
624+
617625
#### Filter authentication requests to target SAML entities
618626
If using the `SAMLMirrorFrontend` module and some of the target providers should support some additional SP's, the
619627
`DecideIfRequesterIsAllowed` micro service can be used. It provides a rules mechanism to describe which SP's are
@@ -679,6 +687,15 @@ persistent NameID may also be obtained from attributes returned from the LDAP di
679687
LDAP microservice install the extra necessary dependencies with `pip install satosa[ldap]` and then see the
680688
[example config](../example/plugins/microservices/ldap_attribute_store.yaml.example).
681689

690+
#### Minimal support for IdP Hinting
691+
692+
It's possible to hint an IdP to SaToSa using `IdpHinting` microservice. See the
693+
[example configuration](../example/plugins/microservices/idp_hinting.yaml.example).
694+
695+
With this feature an SP can send an hint about the IdP to avoid the discovery
696+
service page to the users, using a url parameter. Example
697+
`https://[...]?[...]&idphint=https://that.idp.entity.id"`
698+
682699
### Custom plugins
683700

684701
It's possible to write custom plugins which can be loaded by SATOSA. They have to be contained in a Python module,
@@ -734,4 +751,3 @@ set SATOSA_CONFIG=/home/user/proxy_conf.yaml
734751
## Using Apache HTTP Server and mod\_wsgi
735752

736753
See the [auxiliary documentation for running using mod\_wsgi](mod_wsgi.md).
737-

0 commit comments

Comments
 (0)