diff options
Diffstat (limited to 'doc/manual.html')
-rw-r--r-- | doc/manual.html | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/doc/manual.html b/doc/manual.html index 3073b19..610bc02 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -1244,6 +1244,79 @@ returns the time. It is used to issue DPoP proofs. </p> </info:deffn> + <p> + The identity provider needs to call the application on the + web. So, your client should have a public endpoint on the web. + </p> + <info:deffn type="function" name="serve-application" arguments="id redirect-uri [#client-name] [#client-uri]"> + <p> + Return a handler for web requests to serve the application + manifest and the redirection to transmit the authorization + code. You should set the <info:var>client-name</info:var> to + your application name and <info:var>client-uri</info:var> to + point to where to a presentation of your application. + </p> + </info:deffn> + <p> + The <pre>webid-oidc-client-service</pre> program can run a + server to serve these resources. It is invoked with the + following options: + </p> + <ul> + <li> + <pre>-h</pre>, or <pre>--help</pre> prints a summary of the + options and exit. + </li> + <li> + <pre>-v</pre>, or <pre>--version</pre> prints the version of + the program and exits. + </li> + <li> + <pre>-i <info:var>URI</info:var></pre>, or + <pre>--client-id=<info:var>URI</info:var></pre> sets the + global identitifier of the application, which is dereferenced + to a semantic resource. + </li> + <li> + <pre>-r <info:var>URI</info:var></pre>, or + <pre>--redirect-uri=<info:var>URI</info:var></pre> sets the + redirection URI. + </li> + <li> + <pre>-n <info:var>NAME</info:var></pre>, or + <pre>--client-name=<info:var>NAME</info:var></pre> sets the + name of your application, so that it is shown when the user + gets an authorization. The webid-oidc issuer program that + comes with this package does not display it, because it could + be dishonest, but other implementations might. + </li> + <li> + <pre>-u <info:var>URI</info:var></pre>, or + <pre>--client-uri=<info:var>URI</info:var></pre>, sets an URI + for the identity provider to learn more about your app. + </li> + <li> + <pre>-p <info:var>PORT</info:var></pre>, or + <pre>--port=<info:var>PORT</info:var></pre>, change the port + number used by the server. By default, it is set to 8080. + </li> + <li> + <pre>-l <info:var>FILE.log</info:var></pre>, or + <pre>--log-file=<info:var>FILE.log</info:var></pre> let the + server dump all its output to <info:var>FILE.log</info:var>. + </li> + <li> + <pre>-e <info:var>FILE.err</info:var></pre>, or + <pre>--error-file=<info:var>FILE.err</info:var></pre> let the + server dump all its errors to <info:var>FILE.err</info:var>. + </li> + </ul> + <p> + The program is sensitive to the environment variable + <emph>LANG</emph>, which influences how the program is + internationalized to the server administrator. This changes the + long form of the options, and the language in the log files. + </p> <h1 type="appendix">GNU Free Documentation License</h1> <info:gfdl /> |