mirror of
https://github.com/rclone/rclone.git
synced 2025-12-11 22:14:05 +01:00
doi: add new doi backend
Add a new backend to support mounting datasets published with a digital object identifier (DOI).
This commit is contained in:
Flora Thiebaut
GitHub
187
docs/content/doi.md
Normal file
187
docs/content/doi.md
Normal file
@@ -0,0 +1,187 @@
|
||||
---
|
||||
title: "DOI"
|
||||
description: "Rclone docs for DOI"
|
||||
versionIntroduced: "?"
|
||||
---
|
||||
|
||||
# {{< icon "fa fa-building-columns" >}} DOI
|
||||
|
||||
The DOI remote is a read only remote for reading files from digital object identifiers (DOI).
|
||||
|
||||
Currently, the DOI backend supports supports DOIs hosted with:
|
||||
- [InvenioRDM](https://inveniosoftware.org/products/rdm/)
|
||||
- [Zenodo](https://zenodo.org)
|
||||
- [CaltechDATA](https://data.caltech.edu)
|
||||
- [Other InvenioRDM repositories](https://inveniosoftware.org/showcase/)
|
||||
- [Dataverse](https://dataverse.org)
|
||||
- [Harvard Dataverse](https://dataverse.harvard.edu)
|
||||
- [Other Dataverse repositories](https://dataverse.org/installations)
|
||||
|
||||
Paths are specified as `remote:path`
|
||||
|
||||
Paths may be as deep as required, e.g. `remote:directory/subdirectory`.
|
||||
|
||||
## Configuration
|
||||
|
||||
Here is an example of how to make a remote called `remote`. First run:
|
||||
|
||||
rclone config
|
||||
|
||||
This will guide you through an interactive setup process:
|
||||
|
||||
```
|
||||
No remotes found, make a new one?
|
||||
n) New remote
|
||||
s) Set configuration password
|
||||
q) Quit config
|
||||
n/s/q> n
|
||||
Enter name for new remote.
|
||||
name> remote
|
||||
Type of storage to configure.
|
||||
Choose a number from below, or type in your own value
|
||||
[snip]
|
||||
XX / DOI datasets
|
||||
\ (doi)
|
||||
[snip]
|
||||
Storage> doi
|
||||
Option doi.
|
||||
The DOI or the doi.org URL.
|
||||
Enter a value.
|
||||
doi> 10.5281/zenodo.5876941
|
||||
Edit advanced config?
|
||||
y) Yes
|
||||
n) No (default)
|
||||
y/n> n
|
||||
Configuration complete.
|
||||
Options:
|
||||
- type: doi
|
||||
- doi: 10.5281/zenodo.5876941
|
||||
Keep this "remote" remote?
|
||||
y) Yes this is OK (default)
|
||||
e) Edit this remote
|
||||
d) Delete this remote
|
||||
y/e/d> y
|
||||
```
|
||||
|
||||
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/doi/doi.go then run make backenddocs" >}}
|
||||
### Standard options
|
||||
|
||||
Here are the Standard options specific to doi (DOI datasets).
|
||||
|
||||
#### --doi-doi
|
||||
|
||||
The DOI or the doi.org URL.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: doi
|
||||
- Env Var: RCLONE_DOI_DOI
|
||||
- Type: string
|
||||
- Required: true
|
||||
|
||||
### Advanced options
|
||||
|
||||
Here are the Advanced options specific to doi (DOI datasets).
|
||||
|
||||
#### --doi-provider
|
||||
|
||||
DOI provider.
|
||||
|
||||
The DOI provider can be set when rclone does not automatically recognize a supported DOI provider.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: provider
|
||||
- Env Var: RCLONE_DOI_PROVIDER
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
- "auto"
|
||||
- Auto-detect provider
|
||||
- "zenodo"
|
||||
- Zenodo
|
||||
- "dataverse"
|
||||
- Dataverse
|
||||
- "invenio"
|
||||
- Invenio
|
||||
|
||||
#### --doi-doi-resolver-api-url
|
||||
|
||||
The URL of the DOI resolver API to use.
|
||||
|
||||
The DOI resolver can be set for testing or for cases when the the canonical DOI resolver API cannot be used.
|
||||
|
||||
Defaults to "https://doi.org/api".
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: doi_resolver_api_url
|
||||
- Env Var: RCLONE_DOI_DOI_RESOLVER_API_URL
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --doi-description
|
||||
|
||||
Description of the remote.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: description
|
||||
- Env Var: RCLONE_DOI_DESCRIPTION
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
## Backend commands
|
||||
|
||||
Here are the commands specific to the doi backend.
|
||||
|
||||
Run them with
|
||||
|
||||
rclone backend COMMAND remote:
|
||||
|
||||
The help below will explain what arguments each command takes.
|
||||
|
||||
See the [backend](/commands/rclone_backend/) command for more
|
||||
info on how to pass options and arguments.
|
||||
|
||||
These can be run on a running backend using the rc command
|
||||
[backend/command](/rc/#backend-command).
|
||||
|
||||
### metadata
|
||||
|
||||
Show metadata about the DOI.
|
||||
|
||||
rclone backend metadata remote: [options] [<arguments>+]
|
||||
|
||||
This command returns a JSON object with some information about the DOI.
|
||||
|
||||
rclone backend medatadata doi:
|
||||
|
||||
It returns a JSON object representing metadata about the DOI.
|
||||
|
||||
|
||||
### set
|
||||
|
||||
Set command for updating the config parameters.
|
||||
|
||||
rclone backend set remote: [options] [<arguments>+]
|
||||
|
||||
This set command can be used to update the config parameters
|
||||
for a running doi backend.
|
||||
|
||||
Usage Examples:
|
||||
|
||||
rclone backend set doi: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||
rclone rc backend/command command=set fs=doi: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
|
||||
rclone rc backend/command command=set fs=doi: -o doi=NEW_DOI
|
||||
|
||||
The option keys are named as they are in the config file.
|
||||
|
||||
This rebuilds the connection to the doi backend when it is called with
|
||||
the new parameters. Only new parameters need be passed as the values
|
||||
will default to those currently in use.
|
||||
|
||||
It doesn't return anything.
|
||||
|
||||
|
||||
{{< rem autogenerated options stop >}}
|
||||
Reference in New Issue
Block a user