diff --git a/README.md b/README.md index 29abaec79374fd7aa22de9435f4fdc2524cc892a..b9eb5608aaff57a95d5d65ef5b7ea3aa2e279354 100644 --- a/README.md +++ b/README.md @@ -2,32 +2,4 @@ [GitLab](https://gitlab.tugraz.at/dbp/relay/dbp-relay-auth-bundle) | [Packagist](https://packagist.org/packages/dbp/relay-auth-bundle) -## Bundle Configuration - -created via `./bin/console config:dump-reference DbpRelayAuthBundle | sed '/^$/d'` - -```yaml -# Default configuration for "DbpRelayAuthBundle" -dbp_relay_auth: - # The base URL for the OIDC server (in case of Keycloak fort the specific realm) - server_url: ~ # Example: 'https://keycloak.example.com/auth/realms/my-realm' - # If set only tokens which contain this audience are accepted (optional) - required_audience: ~ # Example: my-api - # How much the system time of the API server and the Keycloak server - # can be out of sync (in seconds). Used for local token validation. - local_validation_leeway: 120 - # If remote validation should be used. If set to false the token signature will - # be only checked locally and not send to the keycloak server - remote_validation: false - # The ID of the client (client credentials flow) used for remote token validation - # (optional) - remote_validation_id: ~ # Example: client-token-check - # The client secret for the client referenced by client_id (optional) - remote_validation_secret: ~ # Example: mysecret - # The Keycloak server base URL - frontend_keycloak_server: ~ # Example: 'https://keycloak.example.com/auth' - # The keycloak realm - frontend_keycloak_realm: ~ # Example: client-docs - # The ID for the keycloak client (authorization code flow) used for API docs or similar - frontend_keycloak_client_id: ~ # Example: client-docs -``` \ No newline at end of file +Docs: see ./docs diff --git a/docs/config.md b/docs/config.md new file mode 100644 index 0000000000000000000000000000000000000000..2848ce431aaec2b8ba6b644f8b0a7ea2bcf29727 --- /dev/null +++ b/docs/config.md @@ -0,0 +1,29 @@ +## Bundle Configuration + +created via `./bin/console config:dump-reference DbpRelayAuthBundle | sed '/^$/d'` + +```yaml +# Default configuration for "DbpRelayAuthBundle" +dbp_relay_auth: + # The base URL for the OIDC server (in case of Keycloak fort the specific realm) + server_url: ~ # Example: 'https://keycloak.example.com/auth/realms/my-realm' + # If set only tokens which contain this audience are accepted (optional) + required_audience: ~ # Example: my-api + # How much the system time of the API server and the Keycloak server + # can be out of sync (in seconds). Used for local token validation. + local_validation_leeway: 120 + # If remote validation should be used. If set to false the token signature will + # be only checked locally and not send to the keycloak server + remote_validation: false + # The ID of the client (client credentials flow) used for remote token validation + # (optional) + remote_validation_id: ~ # Example: client-token-check + # The client secret for the client referenced by client_id (optional) + remote_validation_secret: ~ # Example: mysecret + # The Keycloak server base URL + frontend_keycloak_server: ~ # Example: 'https://keycloak.example.com/auth' + # The keycloak realm + frontend_keycloak_realm: ~ # Example: client-docs + # The ID for the keycloak client (authorization code flow) used for API docs or similar + frontend_keycloak_client_id: ~ # Example: client-docs +``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000000000000000000000000000000000..ca1e30b4cfc70ed11aebd85dfb10e2025193963b --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# About \ No newline at end of file