Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description of Configuration Setting ArchiverClassName not Correct #8047

Closed
shlake opened this issue Aug 4, 2021 · 5 comments · Fixed by #9073
Closed

Description of Configuration Setting ArchiverClassName not Correct #8047

shlake opened this issue Aug 4, 2021 · 5 comments · Fixed by #9073
Labels
Feature: Installation Guide Hackathon: Low Hanging Fruit hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ Help Wanted: Documentation Mentor: pdurbin
Milestone

Comments

@shlake
Copy link
Contributor

shlake commented Aug 4, 2021

https://guides.dataverse.org/en/5.4/installation/config.html#archiverclassname

Should read:
Your Dataverse installation can export archival “Bag” files to an extensible set of storage systems (see BagIt Export above for details about this and for further explanation of the other archiving related settings below). This setting specifies which storage system to use by identifying the particular Java class that should be run. Current options include DuraCloudSubmitToArchiveCommand, LocalSubmitToArchiveCommand, and GoogleCloudSubmitToArchiveCommand - see the following examples.

Replace the current example with these three:

curl -X PUT -d "edu.harvard.iq.dataverse.engine.command.impl.LocalSubmitToArchiveCommand" http://localhost:8080/api/admin/settings/:ArchiverClassName

curl http://localhost:8080/api/admin/settings/:ArchiverClassName -X PUT -d "edu.harvard.iq.dataverse.engine.command.impl.GoogleCloudSubmitToArchiveCommand"

curl http://localhost:8080/api/admin/settings/:ArchiverClassName -X PUT -d "edu.harvard.iq.dataverse.engine.command.impl.DuraCloudSubmitToArchiveCommand"

@shlake
Copy link
Contributor Author

shlake commented Aug 4, 2021

Sherry will fix this and make a PR request for this on Friday

@shlake shlake changed the title Correct Description of Configuration Setting ArchiverClassName Description of Configuration Setting ArchiverClassName not Correct Aug 4, 2021
@pdurbin pdurbin added Hackathon: Low Hanging Fruit Feature: Installation Guide Help Wanted: Documentation Mentor: pdurbin hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ labels Oct 1, 2022
@pdurbin
Copy link
Member

pdurbin commented Oct 1, 2022

@shlake or during Hacktoberfest! 🚀

@shlake
Copy link
Contributor Author

shlake commented Oct 3, 2022

Yes, better late than never ;-)

@shlake
Copy link
Contributor Author

shlake commented Oct 10, 2022

@qqmyers
I am "fixing" this doc issue (for the Hackfest), but wanted to make sure that it still needs correcting.

For :ArchiverClassName
https://guides.dataverse.org/en/latest/installation/config.html#archiverclassname

Is this command correct (which is in the docs)?
curl -X PUT -d 'LocalSubmitToArchiveCommand' http://localhost:8080/api/admin/settings/:ArchiverClassName

Or is this one:
curl -X PUT -d 'edu.harvard.iq.dataverse.engine.command.impl.LocalSubmitToArchiveCommand' http://localhost:8080/api/admin/settings/:ArchiverClassName

OR does it matter?

@qqmyers
Copy link
Member

qqmyers commented Oct 10, 2022

Looks like the full path name is required. FWIW: There is also an S3SubmitToArchiveCommand - see https://guides.dataverse.org/en/latest/installation/config.html#s3-configuration. The sections in https://guides.dataverse.org/en/latest/installation/config.html#bagit-file-handler also have correct curl commands, so one fix might just be to redirect people there instead of repeating the examples.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Installation Guide Hackathon: Low Hanging Fruit hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ Help Wanted: Documentation Mentor: pdurbin
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants