Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 13, 2023
1 parent 8d7a8c3 commit 5c556f2
Show file tree
Hide file tree
Showing 19 changed files with 1,136 additions and 1,063 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"java.lang.Boolean","key":".basic","additionalKeys":[],"configDoc":"If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. If no authentication mechanisms are configured basic auth is the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"basic","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".form","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.FormAuthConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".form.enabled","additionalKeys":[],"configDoc":"If form authentication is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.login-page","additionalKeys":[],"configDoc":"The login page. Redirect to login page can be disabled by setting `quarkus.http.auth.form.login-page=`.","withinAMap":false,"defaultValue":"/login.html","javaDocSiteLink":"","docMapKey":"login-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.post-location","additionalKeys":[],"configDoc":"The post location.","withinAMap":false,"defaultValue":"/j_security_check","javaDocSiteLink":"","docMapKey":"post-location","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.username-parameter","additionalKeys":[],"configDoc":"The username field name.","withinAMap":false,"defaultValue":"j_username","javaDocSiteLink":"","docMapKey":"username-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.password-parameter","additionalKeys":[],"configDoc":"The password field name.","withinAMap":false,"defaultValue":"j_password","javaDocSiteLink":"","docMapKey":"password-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.error-page","additionalKeys":[],"configDoc":"The error page. Redirect to error page can be disabled by setting `quarkus.http.auth.form.error-page=`.","withinAMap":false,"defaultValue":"/error.html","javaDocSiteLink":"","docMapKey":"error-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.landing-page","additionalKeys":[],"configDoc":"The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting `quarkus.http.auth.form.landing-page=`.","withinAMap":false,"defaultValue":"/index.html","javaDocSiteLink":"","docMapKey":"landing-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.location-cookie","additionalKeys":[],"configDoc":"Option to control the name of the cookie used to redirect the user back to where he wants to get access to.","withinAMap":false,"defaultValue":"quarkus-redirect-location","javaDocSiteLink":"","docMapKey":"location-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".form.timeout","additionalKeys":[],"configDoc":"The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.","withinAMap":false,"defaultValue":"PT30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".form.new-cookie-interval","additionalKeys":[],"configDoc":"How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as \"renewal-timeout\". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often), however larger values affect the inactivity timeout as the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a users last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request, as the timeout is only refreshed when a new cookie is generated. In other words no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.","withinAMap":false,"defaultValue":"PT1M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"new-cookie-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.cookie-name","additionalKeys":[],"configDoc":"The cookie that is used to store the persistent session","withinAMap":false,"defaultValue":"quarkus-credential","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.cookie-path","additionalKeys":[],"configDoc":"The cookie path for the session and location cookies.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".form.http-only-cookie","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http-only-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.FormAuthConfig.CookieSameSite","key":".form.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session and location cookies.","withinAMap":false,"defaultValue":"strict","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"BUILD_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".realm","additionalKeys":[],"configDoc":"The authentication realm","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"realm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".proactive","additionalKeys":[],"configDoc":"If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"proactive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
[{"configDocKey":{"type":"java.lang.Boolean","key":".basic","additionalKeys":[],"configDoc":"If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. If no authentication mechanisms are configured basic auth is the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"basic","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".form","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.http.runtime.FormAuthConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".form.enabled","additionalKeys":[],"configDoc":"If form authentication is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".form.post-location","additionalKeys":[],"configDoc":"The post location.","withinAMap":false,"defaultValue":"/j_security_check","javaDocSiteLink":"","docMapKey":"post-location","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".proactive","additionalKeys":[],"configDoc":"If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"proactive","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If form authentication is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".login-page","additionalKeys":[],"configDoc":"The login page. Redirect to login page can be disabled by setting `quarkus.http.auth.form.login-page=`.","withinAMap":false,"defaultValue":"/login.html","javaDocSiteLink":"","docMapKey":"login-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".post-location","additionalKeys":[],"configDoc":"The post location.","withinAMap":false,"defaultValue":"/j_security_check","javaDocSiteLink":"","docMapKey":"post-location","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".username-parameter","additionalKeys":[],"configDoc":"The username field name.","withinAMap":false,"defaultValue":"j_username","javaDocSiteLink":"","docMapKey":"username-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".password-parameter","additionalKeys":[],"configDoc":"The password field name.","withinAMap":false,"defaultValue":"j_password","javaDocSiteLink":"","docMapKey":"password-parameter","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".error-page","additionalKeys":[],"configDoc":"The error page. Redirect to error page can be disabled by setting `quarkus.http.auth.form.error-page=`.","withinAMap":false,"defaultValue":"/error.html","javaDocSiteLink":"","docMapKey":"error-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".landing-page","additionalKeys":[],"configDoc":"The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting `quarkus.http.auth.form.landing-page=`.","withinAMap":false,"defaultValue":"/index.html","javaDocSiteLink":"","docMapKey":"landing-page","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".location-cookie","additionalKeys":[],"configDoc":"Option to control the name of the cookie used to redirect the user back to where he wants to get access to.","withinAMap":false,"defaultValue":"quarkus-redirect-location","javaDocSiteLink":"","docMapKey":"location-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","additionalKeys":[],"configDoc":"The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.","withinAMap":false,"defaultValue":"PT30M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".new-cookie-interval","additionalKeys":[],"configDoc":"How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as \"renewal-timeout\". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often), however larger values affect the inactivity timeout as the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a users last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request, as the timeout is only refreshed when a new cookie is generated. In other words no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.","withinAMap":false,"defaultValue":"PT1M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"new-cookie-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".cookie-name","additionalKeys":[],"configDoc":"The cookie that is used to store the persistent session","withinAMap":false,"defaultValue":"quarkus-credential","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".cookie-path","additionalKeys":[],"configDoc":"The cookie path for the session and location cookies.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".http-only-cookie","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"http-only-cookie","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.vertx.http.runtime.FormAuthConfig.CookieSameSite","key":".cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session and location cookies.","withinAMap":false,"defaultValue":"strict","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"BUILD_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}]
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If form authentication is enabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".post-location","additionalKeys":[],"configDoc":"The post location.","withinAMap":false,"defaultValue":"/j_security_check","javaDocSiteLink":"","docMapKey":"post-location","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Loading

0 comments on commit 5c556f2

Please sign in to comment.