diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 3cbc0b0757e..e9d1a031da5 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -124,7 +124,9 @@ Once you have your DOI or Handle account credentials and a namespace, configure Configuring Dataverse for DOIs ++++++++++++++++++++++++++++++ -Out of the box, Dataverse is configured for DOIs. Here are the configuration options for DOIs: +By default Dataverse attempts to register DOIs for each dataset and file under a test authority, though you must apply for your own credentials as explained above. + +Here are the configuration options for DOIs: **JVM Options:** @@ -140,6 +142,7 @@ Out of the box, Dataverse is configured for DOIs. Here are the configuration opt - :ref:`:Shoulder <:Shoulder>` - :ref:`:IdentifierGenerationStyle <:IdentifierGenerationStyle>` (optional) - :ref:`:DataFilePIDFormat <:DataFilePIDFormat>` (optional) +- :ref:`:FilePIDsEnabled <:FilePIDsEnabled>` (optional, defaults to true) Configuring Dataverse for Handles +++++++++++++++++++++++++++++++++ @@ -975,9 +978,13 @@ Note that in either case, when using the ``sequentialNumber`` option, datasets a :FilePIDsEnabled ++++++++++++++++ -Enable/disable the publishing of file based PIDs for the whole installation. This is enabled by default +Toggles publishing of file-based PIDs for the entire installation. By default this setting is absent and Dataverse assumes it to be true. + +If you don't want to register file-based PIDs for your installation, set: + +``curl -X PUT -d 'false' http://localhost:8080/api/admin/settings/:FilePIDsEnabled`` -``curl -X PUT -d 'true' http://localhost:8080/api/admin/settings/:FilePIDsEnabled`` +Note: File-level PID registration was added in 4.9 and is required until version 4.9.3. :ApplicationTermsOfUse ++++++++++++++++++++++