Skip to main content
Version: 1.x

Deposit Services

There are currently five implemented deposit services. Here you can view all available configuration options for each deposit service.

Zenodo​

This service is directly integrated with Zenodo.

The Zenodo deposit service supports three authentication methods:

  1. System Access Token — A single personal access token created on Zenodo is configured via DEPOSIT_ZENODO_ACCESS_TOKEN. All users of the OpenCDMP instance share this token when depositing.
  2. OAuth 2.0 (per-user) — Each user authenticates individually via Zenodo OAuth 2.0. Requires creating a developer application on Zenodo and configuring DEPOSIT_ZENODO_CLIENT_ID, DEPOSIT_ZENODO_CLIENT_SECRET, and DEPOSIT_ZENODO_REDIRECT_URL.
  3. User Profile Settings — Users store their personal Zenodo access token in their OpenCDMP profile settings. The token is retrieved per-user at deposit time and remains valid until the user updates it.
warning
  • For OAuth 2.0, a developer application must be created on the Zenodo platform.
  • For System Access Token, the configured token applies to all deposits made from this OpenCDMP instance.

More details about Zenodo authentication here.

Authentication & Core Settings​

Env VariableDescriptionRequiredDefault ValueExample
IDP_ISSUER_URIKeycloak realm URL string.Yes-http://<keycloak-hostname>:<port>/realms/<realm-name>
IDP_CLAIMS_ROLES_PATHKeycloak client roles path.Yes-<keycloak_client>.roles
SECURITY_AUDIENCEKeycloak client scope that security is intended for.Yes-<keycloak-client-scope>
OPENCDMP_DOMAINOpenCDMP URL string.Yes-http://<opencdmp-hostname>:<opencdmp-port>/

Zenodo API Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_ZENODO_URLZenodo API URLNohttps://zenodo.org/api/https://<zenodo-hostname>/api/
DEPOSIT_ZENODO_RECORD_URLZenodo record URL to get specific DOI. The url must contain the {doi id} element, which is handled internally by the OPENCDMP platformNohttps://zenodo.org/doi/{doi_id}https://<zenodo-hostname>/doi/{doi_id}

Zenodo OAuth2 Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_ZENODO_REDIRECT_URLZenodo redirect URL back to OpenCDMP platform.Yes*-http://<opencdmp-hostname>:<opencdmp-port>/deposit/oauth2/code-callaback
DEPOSIT_ZENODO_AUTHORIZATION_URLZenodo URL for authorization.Yes*https://zenodo.org/oauth/authorizehttps://<zenodo-hostname>/oauth/authorize
DEPOSIT_ZENODO_ACCESS_TOKEN_URLZenodo URL to get access token.Yes*https://zenodo.org/oauth/tokenhttps://<zenodo-hostname>/oauth/token
DEPOSIT_ZENODO_CLIENT_IDZenodo client id to get access for deposit with your user account.Yes*-<zenodo-client-id>
DEPOSIT_ZENODO_CLIENT_SECRETZenodo client secret to get access for deposit with your user account.Yes*-<zenodo-client-secret>

*Required only if using OAuth 2.0 authentication method

Zenodo Access Token (Alternative Authentication)​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_ZENODO_ACCESS_TOKENZenodo access token for deposit without user-specific OAuth.Yes**-<zenodo-access-token>

**Required only if NOT using OAuth 2.0

Zenodo Metadata Settings​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_ZENODO_COMMUNITY_IDZenodo community ID to store published DOIs.No-<id>
DEPOSIT_ZENODO_RESOURCE_TYPE_IDZenodo Resource Type of a published plan.No-51715dd3-5590-49f2-b227-6a663c849921
DEPOSIT_ZENODO_PUBLISHER_NAMEDefault value of publisher name.NoZenodo<publisher-name>
DEPOSIT_ZENODO_AFFILIATIONZenodo affiliation.No-OpenCDMP

Zenodo UI Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_ZENODO_HAS_LOGOBoolean value to enable Zenodo logo.Notruetrue
DEPOSIT_ZENODO_LOGO_PATHImage for Zenodo logo.Noclasspath:zenodo.jpgclasspath:<image-name>.<image-type>

Logging Configuration​

Env VariableDescriptionRequiredDefault ValueExample
LOGGING_CONFIG_PATHXml file that stores logging configuration.Noclasspath:logging/logback.xmlclasspath:logging/<file-name>.xml
LOGGING_DEFAULT_LOG_LEVELLevel of error to store. Only 4 values can be assigned: INFO, DEBUG, WARN, ERRORNo-WARN
LOGGING_PATHFile path to store logging.No-logs/

DSpace​

This service is directly integrated with DSpace.

Authentication & Core Settings​

Env VariableDescriptionRequiredDefault ValueExample
IDP_ISSUER_URIKeycloak realm URL string.Yes-http://<keycloak-hostname>:<port>/realms/<realm-name>
IDP_CLAIMS_ROLES_PATHKeycloak client roles path.Yes-<keycloak_client>.roles
SECURITY_AUDIENCEKeycloak client scope that security is intended for.Yes-<keycloak-client-scope>
OPENCDMP_DOMAINOpenCDMP URL string.Yes-http://<opencdmp-hostname>:<opencdmp-port>/

DSpace Authentication​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_DSPACE_USERNAMEDSpace username.Yes-<dspace_username>
DEPOSIT_DSPACE_PASSWORDDSpace password.Yes-<dspace_password>

DSpace API Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_DSPACE_URLDSpace REST API URLNohttps://dspace.org/server/api/https://<dspace-hostname>/api/
DEPOSIT_DSPACE_RECORD_URLDSpace URL to get specific DOI. The url must contain the {doi id} element, which is handled internally by the OPENCDMP platform.Nohttps://dspace.org/handle/{doi_id}https://<dspace-hostname>/doi/{doi_id}
DEPOSIT_DSPACE_COLLECTION_IDThe DSpace collection ID where the items will be stored.Yes-51715dd3-5590-49f2-b227-6a663c849921
DEPOSIT_DSPACE_TYPEType that deposited items have. (CV, more details in REST documentation)NoDatasetDataset

DSpace UI Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_DSPACE_HAS_LOGOBoolean value to enable DSpace logo.Notruetrue
DEPOSIT_DSPACE_LOGO_PATHImage for DSpace logo.Noclasspath:dspace.jpgclasspath:<image-name>.<image-type>

Logging Configuration​

Env VariableDescriptionRequiredDefault ValueExample
LOGGING_CONFIG_PATHXml file that stores logging configuration.Noclasspath:logging/logback.xmlclasspath:logging/<file-name>.xml
LOGGING_DEFAULT_LOG_LEVELLevel of error to store. Only 4 values can be assigned: INFO, DEBUG, WARN, ERRORNo-WARN
LOGGING_PATHFile path to store logging.No-logs/

CKAN​

This service is directly integrated with CKAN.

Authentication & Core Settings​

Env VariableDescriptionRequiredDefault ValueExample
IDP_ISSUER_URIKeycloak realm URL string.Yes-http://<keycloak-hostname>:<port>/realms/<realm-name>
IDP_CLAIMS_ROLES_PATHKeycloak client roles path.Yes-<keycloak_client>.roles
SECURITY_AUDIENCEKeycloak client scope that security is intended for.Yes-<keycloak-client-scope>
OPENCDMP_DOMAINOpenCDMP URL string.Yes-http://<opencdmp-hostname>:<opencdmp-port>/

CKAN Authentication​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_CKAN_ACCESS_TOKENCKAN access token for deposit.Yes-<ckan-access-token>

CKAN API Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_CKAN_URLCKAN REST API URLYes-https://<ckan-hostname>/api/3/action/
DEPOSIT_CKAN_RECORD_URLCKAN URL to get specific DOI. The url must contain the {doi id} element, which is handled internally by the OPENCDMP platformYes-https://<ckan-hostname>/dataset/{doi_id}
DEPOSIT_CKAN_ORGANIZATION_IDThe CKAN organization ID where the items will be stored.Yes-51715dd3-5590-49f2-b227-6a663c849921

CKAN UI Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_CKAN_HAS_LOGOBoolean value to enable CKAN logo.Notruetrue
DEPOSIT_CKAN_LOGO_PATHImage for CKAN logo.Noclasspath:ckan.jpgclasspath:<image-name>.<image-type>

Logging Configuration​

Env VariableDescriptionRequiredDefault ValueExample
LOGGING_CONFIG_PATHXml file that stores logging configuration.Noclasspath:logging/logback.xmlclasspath:logging/<file-name>.xml
LOGGING_DEFAULT_LOG_LEVELLevel of error to store. Only 4 values can be assigned: INFO, DEBUG, WARN, ERRORNo-WARN
LOGGING_PATHFile path to store logging.No-logs/

Dataverse​

This service is directly integrated with Dataverse.

Authentication & Core Settings​

Env VariableDescriptionRequiredDefault ValueExample
IDP_ISSUER_URIKeycloak realm URL string.Yes-http://<keycloak-hostname>:<port>/realms/<realm-name>
IDP_CLAIMS_ROLES_PATHKeycloak client roles path.Yes-<keycloak_client>.roles
SECURITY_AUDIENCEKeycloak client scope that security is intended for.Yes-<keycloak-client-scope>
OPENCDMP_DOMAINOpenCDMP URL string.Yes-http://<opencdmp-hostname>:<opencdmp-port>/

Dataverse Authentication​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_DATAVERSE_ACCESS_TOKENDataverse access token for deposit.Yes-<dataverse-access-token>

Dataverse API Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_DATAVERSE_HOSTDefault host name (previously called Alias).Yes-<dataverse-host>
DEPOSIT_DATAVERSE_URLDataverse REST API URLYes-https://<dataverse-hostname>/api/
DEPOSIT_DATAVERSE_RECORD_URLDataverse URL to get specific DOI. The url must contain the {doi id} element, which is handled internally by the OPENCDMP platformYes-https://<dataverse-hostname>/dataset.xhtml?persistentId={doi_id}

Dataverse UI Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_DATAVERSE_HAS_LOGOBoolean value to enable Dataverse logo.Notruetrue
DEPOSIT_DATAVERSE_LOGO_PATHImage for Dataverse logo.Noclasspath:dataverse.jpgclasspath:<image-name>.<image-type>

Logging Configuration​

Env VariableDescriptionRequiredDefault ValueExample
LOGGING_CONFIG_PATHXml file that stores logging configuration.Noclasspath:logging/logback.xmlclasspath:logging/<file-name>.xml
LOGGING_DEFAULT_LOG_LEVELLevel of error to store. Only 4 values can be assigned: INFO, DEBUG, WARN, ERRORNo-WARN
LOGGING_PATHFile path to store logging.No-logs/

Fedora​

This service is directly integrated with Fedora.

Authentication & Core Settings​

Env VariableDescriptionRequiredDefault ValueExample
IDP_ISSUER_URIKeycloak realm URL string.Yes-http://<keycloak-hostname>:<port>/realms/<realm-name>
IDP_CLAIMS_ROLES_PATHKeycloak client roles path.Yes-<keycloak_client>.roles
SECURITY_AUDIENCEKeycloak client scope that security is intended for.Yes-<keycloak-client-scope>
OPENCDMP_DOMAINOpenCDMP URL string.Yes-http://<opencdmp-hostname>:<opencdmp-port>/

Fedora Authentication​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_FEDORA_USERNAMEFedora username.Yes-<fedora_username>
DEPOSIT_FEDORA_PASSWORDFedora password.Yes-<fedora_password>

Fedora API Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_FEDORA_URLFedora REST API URLNohttps://fedora.org/fcrepo/rest/https://<fedora-hostname>/rest/
DEPOSIT_FEDORA_RECORD_URLFedora URL to get specific DOI. The url must contain the {doi id} element, which is handled internally by the OPENCDMP platformNohttps://fedora.org/fcrepo/rest/{doi_id}https://<fedora-hostname>/{doi_id}

Fedora UI Configuration​

Env VariableDescriptionRequiredDefault ValueExample
DEPOSIT_FEDORA_HAS_LOGOBoolean value to enable Fedora logo.Notruetrue
DEPOSIT_FEDORA_LOGO_PATHImage for Fedora logo.Noclasspath:fedora.pngclasspath:<image-name>.<image-type>

Logging Configuration​

Env VariableDescriptionRequiredDefault ValueExample
LOGGING_CONFIG_PATHXml file that stores logging configuration.Noclasspath:logging/logback.xmlclasspath:logging/<file-name>.xml
LOGGING_DEFAULT_LOG_LEVELLevel of error to store. Only 4 values can be assigned: INFO, DEBUG, WARN, ERRORNo-WARN
LOGGING_PATHFile path to store logging.No-logs/

See Also​