diff --git a/registry/docs/apicurio-registry/3.0.x/getting-started/assembly-config-reference.html b/registry/docs/apicurio-registry/3.0.x/getting-started/assembly-config-reference.html index 9ddae4e..dc43c81 100644 --- a/registry/docs/apicurio-registry/3.0.x/getting-started/assembly-config-reference.html +++ b/registry/docs/apicurio-registry/3.0.x/getting-started/assembly-config-reference.html @@ -1720,7 +1720,7 @@
APICURIO_KAFKA_SQL_BOOTSTRAP_SERVERS
.s
+For each configuration property you can override the value by using the corresponding environment variable, for example, APICURIO_KAFKASQL_BOOTSTRAP_SERVERS
.s
registry-api
APICURIO_UI_AUTH_OIDC_CLIENT_ID
APICURIO_UI_AUTH_OIDC_CLIENT-ID
The client ID for the Apicurio Registry web console.
String
apicurio-registry
APICURIO_AUTH_ROLE_BASED_AUTHORIZATION
APICURIO_AUTH_ROLE-BASED-AUTHORIZATION
apicurio.auth.role-based-authorization
Boolean
false
APICURIO_AUTH_OWNER_ONLY_AUTHORIZATION
apicurio.auth.owner-only-authorization
APICURIO_AUTH_OWNER-ONLY-AUTHORIZATION_LIMIT-GROUP-ACCESS
apicurio.auth.owner-only-authorization.limit-group-access
Boolean
false
QUARKUS_OIDC_CLIENT_ID
QUARKUS_OIDC_CLIENT-ID
The client application ID for the Apicurio Registry REST API
Your Azure AD Application (client) ID obtained in step 5. For example: 123456a7-b8c9-012d-e3f4-5fg67h8i901
APICURIO_UI_AUTH_OIDC_CLIENT_ID
APICURIO_UI_AUTH_OIDC_CLIENT-ID
The client application ID for the Apicurio Registry web console.
Your Azure AD Application (client) ID obtained in step 5. For example: 123456a7-b8c9-012d-e3f4-5fg67h8i901
QUARKUS_OIDC_AUTH_SERVER_URL
QUARKUS_OIDC_AUTH-SERVER-URL
The URL for authentication in Azure AD.
Your Azure AD Application (tenant) ID obtained in step 6. For example: https://login.microsoftonline.com/1a2bc34d-567e-89f1-g0hi-1j2kl3m4no56/v2.0
.
QUARKUS_OIDC_TENANT_ENABLED
QUARKUS_OIDC_TENANT-ENABLED
Enables authentication for Apicurio Registry.
true
APICURIO_UI_AUTH_TYPE
The Apicurio Registry authentication type.
oidc
QUARKUS_HTTP_CORS_ORIGINS
The host for your Apicurio Registry deployment for cross-origin resource sharing (CORS).
For example: https://test-registry.com
APICURIO_UI_AUTH_OIDC_REDIRECT_URI
APICURIO_UI_AUTH_OIDC_REDIRECT-URI
The host for your Apicurio Registry web console.
For example: https://test-registry.com/ui
APICURIO_AUTH_ROLE_BASED_AUTHORIZATION
APICURIO_AUTH_ROLE-BASED-AUTHORIZATION
Enables role-based authorization in Apicurio Registry.
true
QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH
QUARKUS_OIDC_ROLES_ROLE-CLAIM-PATH
The name of the claim in which Azure AD stores roles.
roles
QUARKUS_OIDC_TENANT_ENABLED
QUARKUS_OIDC_TENANT-ENABLED
Enables authentication for Apicurio Registry. When set to true
, the environment variables that follow are required for authentication using Keycloak.
String
false
QUARKUS_OIDC_AUTH_SERVER_URL
QUARKUS_OIDC_AUTH-SERVER-URL
The URL of the Keycloak authentication server. For example, http://localhost:8080
.
String
-
QUARKUS_OIDC_CLIENT_ID
QUARKUS_OIDC_CLIENT-ID
The client ID for the Apicurio Registry REST API.
String
registry-api
APICURIO_UI_AUTH_OIDC_CLIENT_ID
APICURIO_UI_AUTH_OIDC_CLIENT-ID
The client ID for the Apicurio Registry web console.
String
apicurio-registry
-
ROLE_BASED_AUTHZ_ENABLED
APICURIO_AUTH_ROLE-BASED-AUTHORIZATION
Enables or disables role-based authorization.
Boolean
False
QUARKUS_OIDC_TENANT_ENABLED
apicurio.auth.enabled
QUARKUS_OIDC_TENANT-ENABLED
quarkus.oidc.tenant-enabled
Boolean
false
CLIENT_CREDENTIALS_BASIC_ENABLED
apicurio.auth.basic-auth-client-credentials.enabled
APICURIO_AUTHN_BASIC-CLIENT-CREDENTIALS.ENABLED
apicurio.authn.basic-client-credentials.enabled
Boolean
false
CLIENT_CREDENTIALS_BASIC_CACHE_EXPIRATION
apicurio.auth.basic-auth-client-credentials.cache-expiration
APICURIO_AUTHN_BASIC-CLIENT-CREDENTIALS_CACHE-EXPIRATION
apicurio.authn.basic-client-credentials.cache-expiration
Integer
10
QUARKUS_OIDC_TENANT_ENABLED
apicurio.auth.enabled
QUARKUS_OIDC_TENANT-ENABLED
quarkus.oidc.tenant-enabled
Boolean
false
APICURIO_AUTH_ROLE_BASED_AUTHORIZATION
APICURIO_AUTH_ROLE-BASED-AUTHORIZATION
apicurio.auth.role-based-authorization
Boolean
false
ROLE_BASED_AUTHZ_SOURCE
APICURIO_AUTH_ROLE-SOURCE
When set to token
, user roles are taken from the authentication token.
String
token
ROLE_BASED_AUTHZ_SOURCE
APICURIO_AUTH_ROLE-SOURCE
When set to application
, user roles are managed internally by Apicurio Registry.
String
token
APICURIO_AUTH_ADMIN_OVERRIDE_ENABLED
APICURIO_AUTH_ADMIN-OVERRIDE_ENABLED
Enables the admin-override feature.
String
false
APICURIO_AUTH_ADMIN_OVERRIDE_FROM
APICURIO_AUTH_ADMIN-OVERRIDE_FROM
Where to look for admin-override information. Only token
is currently supported.
String
token
APICURIO_AUTH_ADMIN_OVERRIDE_TYPE
APICURIO_AUTH_ADMIN-OVERRIDE_TYPE
The type of information used to determine if a user is an admin. Values depend on the value of the FROM variable, for example, role
or claim
when FROM is token
.
String
role
APICURIO_AUTH_ADMIN_OVERRIDE_ROLE
APICURIO_AUTH_ADMIN-OVERRIDE_ROLE
The name of the role that indicates a user is an admin.
String
sr-admin
APICURIO_AUTH_ADMIN_OVERRIDE_CLAIM
APICURIO_AUTH_ADMIN-OVERRIDE_CLAIM
The name of a JWT token claim to use for determining admin-override.
String
org-admin
APICURIO_AUTH_ADMIN_OVERRIDE_CLAIM_VALUE
APICURIO_AUTH_ADMIN-OVERRIDE_CLAIM-VALUE
The value that the JWT token claim indicated by the CLAIM variable must be for the user to be granted admin-override.
String
true
QUARKUS_OIDC_TENANT_ENABLED
apicurio.auth.enabled
quarkus.oidc.tenant-enabled
Boolean
false
APICURIO_AUTH_OBAC_ENABLED
APICURIO_AUTH_OWNER-ONLY-AUTHORIZATION
apicurio.auth.owner-only-authorization
Boolean
false
APICURIO_AUTH_OBAC_LIMIT_GROUP_ACCESS
APICURIO_AUTH_OWNER-ONLY-AUTHORIZATION_LIMIT-GROUP-ACCESS
apicurio.auth.owner-only-authorization.limit-group-access
Boolean
false
QUARKUS_OIDC_TENANT_ENABLED
apicurio.auth.enabled
QUARKUS_OIDC_TENANT-ENABLED
quarkus.oidc.tenant-enabled
Boolean
false
APICURIO_AUTH_AUTHENTICATED_READS_ENABLED
APICURIO_AUTH_AUTHENTICATED-READ-ACCESS_ENABLED
apicurio.auth.authenticated-read-access.enabled
Boolean
false
QUARKUS_OIDC_TENANT_ENABLED
apicurio.auth.enabled
QUARKUS_OIDC_TENANT-ENABLED
quarkus.oidc.tenant-enabled
Boolean
false
APICURIO_AUTH_ANONYMOUS_READ_ACCESS_ENABLED
APICURIO_AUTH_ANONYMOUS-READ-ACCESS_ENABLED
apicurio.auth.anonymous-read-access.enabled
Boolean
false
kafkasql-journal
APICURIO_KAFKASQL_TOPIC_AUTO_CREATE
APICURIO_KAFKASQL_TOPIC_AUTO-CREATE
apicurio.kafkasql.topic.auto-create
true
false
APICURIO_KAFKASQL_SECURITY_SASL_CLIENT_IDapicurio.kafkasql.security.sasl.client-id
APICURIO_KAFKASQL_SECURITY_SASL_CLIENT-ID
The client ID used to authenticate to Kafka.
-
APICURIO_KAFKASQL_SECURITY_SASL_CLIENT_SECRET
APICURIO_KAFKASQL_SECURITY_SASL_CLIENT-SECRET
The client secret used to authenticate to Kafka.
-
APICURIO_KAFKASQL_SECURITY_SASL_TOKEN_ENDPOINT
APICURIO_KAFKASQL_SECURITY_SASL_TOKEN-ENDPOINT
The URL of the OAuth identity server.
http://localhost:8090