Skip to content

Configuration

John Bradley edited this page Jul 24, 2020 · 6 revisions

Config file locations

There are two configuration files supported by DukeDSClient.

  • /etc/ddsclient.conf - global configuration settings
  • ~/.ddsclient - user configuration settings that will override the global configuration The user configuration file location is overridable by setting the environment variable DDSCLIENT_CONF.

Config file options

  • url - url to the DukeDS service. (default=https://api.dataservice.duke.edu/api/v1) This can be set to the dev or uatest servers for testing purposes.
  • user_key - key that identifies the user we are using with the DukeDS service.
  • agent_key - key that identifies the software agent we are using with the DukeDS service.
  • auth - temporary authorization token to use instead of user_key/agent_key. (default= value of DUKE_DATA_SERVICE_AUTH environment variable).
  • upload_bytes_per_chunk - size of a chunk of a file uploaded to DukeDS. (default=100MB)- can change how long it takes to upload a file.
  • upload_workers - how many workers (CPUs) to use when uploading. (default=number CPUs on machine or 8 whichever is less)
  • download_workers - how many workers (CPUs) to use when downloading. (default=number CPUs on machine or 8 whichever is less)
  • download_bytes_per_chunk - size of a chunk of a file downloaded from DukeDS. (default=20MB)
  • debug - set to True to print a stack trace on error instead of just the message. (default=False)
  • d4s2_url - url to the d4s2 share service. (default=https://d4s2.gcb.duke.edu/api/v1)
  • file_exclude_regex - regular expression that determines which files are to be skipped. (default=^.DS_Store$|^.ddsclient$|^._). This excludes ., .DS_Store and .ddsclient config files.
  • get_page_size - how many items to fetch in one page from a DukeDS resource. Default 100. This value can be decreased if you are having trouble working with large projects that result in 500 errors due to DukeDS timeouts. Decreasing this value will make fetching project details take longer.