Skip to content
vjrj edited this page Aug 21, 2024 · 3 revisions

The DOI service is an optional service in the ALA stack. It is typically installed on a subdomain, for example, https://doi.ala.org.au, and when activated, record downloads automatically generate a DOI for them. If it is not activated, downloads are generated with a link to your portal's biocache service.

The installation of the DOI service is quite similar to other ALA services, and once deployed, the rest of the services need to be configured to know where this DOI service resides. For instance in /data/biocache/config/biocache-config.properties:

# Base URL for DOI service DOI
doi.ui.url=https://doi.l-a.site
doi.service.url=https://doi.l-a.site/api/

and similary in other services.

The next step is to configure the DOI provider. Currently, two providers are supported: DATACITE and ANDS (the Australian National Data Service), which is used by ALA.

This is selected in the configuration at /data/doi-service/config/doi-service-config.yml:

doi:
  service:
    # ANDS or DATACITE
    provider:
      mapping: { ALA: 'DATACITE' }

Additionally, the account for, for example, DataCite, is also configured in that same configuration, with a username, password, etc., for example:

datacite:
  doi:
    service:
      baseApiUrl: https://api.datacite.org/
      user: YOU_USER
      password: SOMEPASSWORD
      prefix: '10.99999'
      shoulder: l-a.site

Once this is working, the service is activated in the biocache hub downloads /data/ala-hub/config/ala-hub-config.properties:

doi.mintDoi=true

The downloads can be configured to be stored locally or in AWS S3, for instance:

doi:
  service:
    # ANDS or DATACITE
    provider:
      mapping: { ALA: 'DATACITE' }
  storage:
    provider: LOCAL
Clone this wiki locally