diff options
Diffstat (limited to 'doc/disfluid.texi')
-rw-r--r-- | doc/disfluid.texi | 50 |
1 files changed, 46 insertions, 4 deletions
diff --git a/doc/disfluid.texi b/doc/disfluid.texi index 6247bfa..a73a5c7 100644 --- a/doc/disfluid.texi +++ b/doc/disfluid.texi @@ -60,6 +60,7 @@ is tracked in the Guix channel * Decentralized Authentication on the Web:: * Invoking disfluid:: * Running disfluid with GNU Guix:: +* Common parameters:: * Managing keys:: * OIDC discovery:: * The Json Web Token:: @@ -282,6 +283,48 @@ This record configures a server to serve public application pages. The configuration for the full server. @end deftp +@node Common parameters +@chapter Common parameters +The @emph{(webid-oidc parameters)} module provides a set of Guile +parameter to control the program behavior. + +@deffn {parameter} data-home +This parameter controls the location where the program stores +persistent data. By default, it is located in @code{XDG_DATA_HOME}. +@end deffn + +@deffn {parameter} cache-home +This parameter controls the location where the program stores data +that might get deleted at any time. By default, it uses +@code{XDG_CACHE_HOME}. +@end deffn + +@deffn {parameter} current-date +This parameter is a thunk similar to SRFI-19 @code{current-date}, +except it can be set with a thunk returning a date, time or number of +seconds, or a date, time or number of seconds. +@end deffn + +@deffn {parameter} anonymous-http-request +This parameter is a function similar to the @code{http-request} +function in @emph{(web client)}. +@end deffn + +@deffn {parameter} authorization-code-default-validity +This parameter controls the number of seconds for which an +authorization code is valid at creation time. +@end deffn + +@deffn {parameter} oidc-token-default-validity +This parameter controls the number of seconds for which an ID token or +access token is valid at creation time. +@end deffn + +@deffn {parameter} dpop-proof-validity +This parameter controls the number of seconds for which a DPoP proof +is valid after it has been issued. +@end deffn + @node Managing keys @chapter Managing keys @@ -1256,10 +1299,9 @@ with the cache. Drop @var{percents}% of the cache right now. @end deffn -@deffn function with-cache @var{[#http-get]} -Return a function acting as @emph{http-get} from @emph{(web client)} -(takes an URI as the first parameter, and an optional @var{#:headers} -set, and returns 2 values, the response and its body). +@deffn function use-cache @var{f} +Call @var{f} with no arguments, with the default HTTP request method +set to a function that tries to use the cache first.o The cache will be read and written in the @samp{web-cache} subdirectory of the cache home. To check the time window validity, the |