diff options
Diffstat (limited to 'texinfo/challenger.texi')
| -rw-r--r-- | texinfo/challenger.texi | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/texinfo/challenger.texi b/texinfo/challenger.texi index d336c6c4..53f57e43 100644 --- a/texinfo/challenger.texi +++ b/texinfo/challenger.texi @@ -10,9 +10,9 @@ @paragraphindent 0 @exampleindent 4 @finalout -@dircategory Networking +@dircategory Network applications @direntry -* Challenger: (challenger.info). OAuth2-based customer address validation service +* GNU Taler Challenger: (challenger.info). Customer address validation service @end direntry @c %**end of header @@ -23,7 +23,7 @@ GNU Taler 0.9.4, Mar 07, 2024 GNU Taler team -Copyright @copyright{} 2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +Copyright @copyright{} 2014-2024 Taler Systems SA (GPLv3+ or GFDL 1.3+) @end quotation @end copying @@ -201,7 +201,7 @@ in a Postgres database by the Challenger service. @chapter Installation -In this guide's shell-session fragments, the command prompt shows two pieces +In this guide’s shell-session fragments, the command prompt shows two pieces of information: @@ -247,7 +247,7 @@ backend: @itemize - @item -"Sphinx RTD Theme" Python package aka @code{python3-sphinx-rtd-theme} +“Sphinx RTD Theme” Python package aka @code{python3-sphinx-rtd-theme} on Debian-based systems (for GNUnet documentation support, can be omitted if GNUnet is configured with @code{--disable-documentation}) @@ -344,7 +344,7 @@ In any case, if @code{make check} fails, please consider filing a bug report with the Taler bug tracker@footnote{https://bugs.taler.net}. There is no need to actually run a GNUnet peer or a Taler exchange to use -Challenger -- all Challenger needs from GNUnet and Taler are a number of +Challenger – all Challenger needs from GNUnet and Taler are a number of headers and libraries! After installing GNUnet, unpack the GNU Taler exchange tarball, @@ -763,7 +763,7 @@ setup and configure the legal conditions. @section Terms of Service -The service has an endpoint "/terms" to return the terms of service (in legal +The service has an endpoint “/terms” to return the terms of service (in legal language) of the service operator. Client software show these terms of service to the user when the user is first interacting with the service. Terms of service are optional for experimental deployments, if none are @@ -777,7 +777,7 @@ in the configuration file for the service: @itemize - @item -@code{TERMS_ETAG}: The current "Etag" to return for the terms of service. +@code{TERMS_ETAG}: The current “Etag” to return for the terms of service. This value must be changed whenever the terms of service are updated. A common value to use would be a version number. Note that if you change the @code{TERMS_ETAG}, you MUST also provide @@ -794,7 +794,7 @@ process. @section Privacy Policy -The service has an endpoint "/pp" to return the terms privacy policy (in legal +The service has an endpoint “/pp” to return the terms privacy policy (in legal language) of the service operator. Clients should show the privacy policy to the user when the user explicitly asks for it, but it should not be shown by default. Privacy policies are optional for experimental deployments, if none @@ -808,7 +808,7 @@ in the configuration file for the service: @itemize - @item -@code{PRIVACY_ETAG}: The current "Etag" to return for the privacy policy. +@code{PRIVACY_ETAG}: The current “Etag” to return for the privacy policy. This value must be changed whenever the privacy policy is updated. A common value to use would be a version number. Note that if you change the @code{PRIVACY_ETAG}, you MUST also provide @@ -829,7 +829,7 @@ The @code{TERMS_DIR} and @code{PRIVACY_DIR} directory structures must follow a particular layout. You may use the same directory for both the terms of service and the privacy policy, as long as you use different ETAGs. Inside of the directory, there should be sub-directories using two-letter language codes -like "en", "de", or "jp". Each of these directories would then hold +like “en”, “de”, or “jp”. Each of these directories would then hold translations of the current terms of service into the respective language. Empty directories are permitted in case translations are not available. @@ -837,7 +837,7 @@ Then, inside each language directory, files with the name of the value set as the @code{TERMS_ETAG} or @code{PRIVACY_ETAG} must be provided. The extension of each of the files should be typical for the respective mime type. The set of supported mime types is currently hard-coded in the service, and includes -".epub", ".html", ".md", ".pdf" and ".txt" files. If other files are present, +“.epub”, “.html”, “.md”, “.pdf” and “.txt” files. If other files are present, the service may show a warning on startup. @menu @@ -850,7 +850,7 @@ the service may show a warning on startup. @subsection Example -A sample file structure for a @code{TERMS_ETAG} of "tos-v0" would be: +A sample file structure for a @code{TERMS_ETAG} of “tos-v0” would be: @itemize - @@ -886,8 +886,8 @@ TERMS_DIR/de/tos-v0.epub TERMS_DIR/de/tos-v0.md @end itemize -If the user requests an HTML format with language preferences "fr" followed by -"en", the service would return @code{TERMS_DIR/en/tos-v0.html} lacking a version in +If the user requests an HTML format with language preferences “fr” followed by +“en”, the service would return @code{TERMS_DIR/en/tos-v0.html} lacking a version in French. @node Generating the Legal Terms,Adding translations,Legal policies directory layout,Configuration Fundamentals @@ -1336,7 +1336,7 @@ The template is instantiated using the following information: @itemize * @item -restrictions: Object; map of keys (names of the fields of the address to be entered by the user) to objects with a "regex" (string) containing an extended Posix regular expression for allowed address field values, and a "hint"/"hint_i18n" giving a human-readable explanation to display if the value entered by the user does not match the regex. Keys that are not mapped to such an object have no restriction on the value provided by the user. See "ADDRESS_RESTRICTIONS" in the challenger configuration. +restrictions: Object; map of keys (names of the fields of the address to be entered by the user) to objects with a “regex” (string) containing an extended Posix regular expression for allowed address field values, and a “hint”/”hint_i18n” giving a human-readable explanation to display if the value entered by the user does not match the regex. Keys that are not mapped to such an object have no restriction on the value provided by the user. See “ADDRESS_RESTRICTIONS” in the challenger configuration. @item fix_address: boolean; indicates if the given address cannot be changed |