Skip to content
Snippets Groups Projects
Commit e1d2a0f2 authored by Reiter, Christoph's avatar Reiter, Christoph :snake:
Browse files

Move the docs into a subdirectory

I want to test including it into the main docs via a submodule
parent 89d4166c
No related branches found
No related tags found
No related merge requests found
Pipeline #57398 passed
......@@ -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
## 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
# About
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment