Skip to content

Commit e7cf67c

Browse files
committed
change signature-secret to signing-secret in config doc
1 parent f2544d4 commit e7cf67c

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

doc/sphinx-guides/source/installation/config.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3308,23 +3308,23 @@ Can also be set via *MicroProfile Config API* sources, e.g. the environment vari
33083308

33093309
**Note:** This setting was previously called `dataverse.personOrOrg.orgPhraseArray` and expected a JsonArray of strings. Please update both the name and value format if using the old setting.
33103310

3311-
.. _dataverse.api.signature-secret:
3311+
.. _dataverse.api.signing-secret:
33123312

3313-
dataverse.api.signature-secret
3313+
dataverse.api.signing-secret
33143314
++++++++++++++++++++++++++++++
33153315

33163316
Context: Dataverse has the ability to create "Signed URLs" for it's API calls. Using a signed URLs is more secure than
33173317
providing API tokens, which are long-lived and give the holder all of the permissions of the user. In contrast, signed URLs
33183318
are time limited and only allow the action of the API call in the URL. See :ref:`api-exttools-auth` and
33193319
:ref:`api-native-signed-url` for more details.
33203320

3321-
The key used to sign a URL is created from the API token of the creating user plus a signature-secret provided by an administrator.
3322-
**Using a signature-secret is highly recommended.** This setting defaults to an empty string. Using a non-empty
3323-
signature-secret makes it impossible for someone who knows an API token from forging signed URLs and provides extra security by
3321+
The key used to sign a URL is created from the API token of the creating user plus a signing-secret provided by an administrator.
3322+
**Using a signing-secret is highly recommended.** This setting defaults to an empty string. Using a non-empty
3323+
signing-secret makes it impossible for someone who knows an API token from forging signed URLs and provides extra security by
33243324
making the overall signing key longer.
33253325

33263326
**WARNING**:
3327-
*Since the signature-secret is sensitive, you should treat it like a password.*
3327+
*Since the signing-secret is sensitive, you should treat it like a password.*
33283328
*See* :ref:`secure-password-storage` *to learn about ways to safeguard it.*
33293329

33303330
Can also be set via any `supported MicroProfile Config API source`_, e.g. the environment variable ``DATAVERSE_API_SIGNATURE_SECRET`` (although you shouldn't use environment variables for passwords) .

0 commit comments

Comments
 (0)