Environment variablesΒΆ

Most arguments and options can be set by an environment variable instead of on the command line, which suits long-running deployments (see Deployment): set connection details and credentials once, e.g. from a Kubernetes Secret, rather than passing them on every invocation. An option given on the command line takes precedence over its environment variable.

An option that takes several values reads them from its variable separated by spaces, unless its help says otherwise (e.g. ACFLOW_FIELDS takes ;-separated entries). A variable can set different options in different commands, e.g. ACFLOW_STAGED sets STAGED for store and INPUT_DIR for check-store xnat; see the Command-line interface for what each option does.

This table is generated from the installed commands, so it lists the variables of any source and store plugins installed when the docs were built.

Variable

Sets

ACFLOW_ACCESSION

--accession of collate folder

ACFLOW_ACQUISITION

--acquisition of collate folder, label folder

ACFLOW_ADDITIONAL_LOGGERS

--additional-logger of annotate, attach, check-store folder, check-store xnat, collate folder, collate orthanc, deidentify, label folder, label xnat, package, store folder, store xnat

ACFLOW_ALLOW_UNRECOGNISED

--allow-unrecognised of collate folder

ACFLOW_ALWAYSINCLUDE

--always-include of check-store xnat, store xnat

ACFLOW_CHECK_CHECKSUMS

--checksums of check-store folder

--check-checksums of store xnat

ACFLOW_COLLATE_RESOURCES

--collate-resources of collate folder

ACFLOW_CONSTANT_LABELS

--constant-label of label folder

ACFLOW_CONSTANT_PROJECT_ID

--constant-project-id of label xnat

ACFLOW_CONVERT

--convert of collate folder, collate orthanc

ACFLOW_COPY_MODE

--copy-mode of attach, collate folder, collate orthanc, deidentify, label folder, label xnat, package

ACFLOW_DATATYPE

DATATYPE of attach

ACFLOW_DATATYPES

--datatype of collate folder

ACFLOW_DATE

--date of store xnat

ACFLOW_DEST

DEST of check-store folder, store folder

ACFLOW_DISABLE_PROGRESS

--disable-progress of check-store xnat

ACFLOW_DONT_READ_METADATA

--dont-read-metadata of collate folder

ACFLOW_DRY_RUN

--dry-run of store xnat

ACFLOW_EXCLUDE_PATH

--exclude-path of collate folder

ACFLOW_FIELDS

--extract of annotate

ACFLOW_GLOB

GLOB of attach

ACFLOW_HASH_UID_KEY

--hash-uid-key of deidentify

ACFLOW_HOST

SERVER of check-store xnat, store xnat

ACFLOW_ID_PATTERN

ID_PATTERN of attach

ACFLOW_IGNORE_DATATYPE

--ignore-datatype of collate folder

ACFLOW_INCLUDE

--include of label folder, label xnat

ACFLOW_INPUT_DIR

INPUT_DIR of annotate, attach, deidentify, label folder, label xnat, package

ACFLOW_INPUT_PATHS

INPUT_PATHS of collate folder

ACFLOW_LEVELS

--level of label folder

ACFLOW_LOGGERS

--logger of annotate, attach, check-store folder, check-store xnat, collate folder, collate orthanc, deidentify, label folder, label xnat, package, store folder, store xnat

ACFLOW_LOOP

--loop of annotate, attach, collate folder, collate orthanc, deidentify, label folder, label xnat, package, store folder, store xnat

ACFLOW_METADATA_ALLOWLIST

--metadata-allowlist of deidentify

ACFLOW_METADATA_TABLES

--metadata-table of collate folder

ACFLOW_METHODS

--method of store xnat

ACFLOW_MODALITY

--modality of store xnat

ACFLOW_NO_UID_CHECK

--no-uid-check of check-store xnat, store xnat

ACFLOW_NUM_FILES_PER_BATCH

--num-files-per-batch of store xnat

ACFLOW_ON_RESOURCE_CLASH

--on-resource-clash of attach, collate folder, deidentify, package

ACFLOW_ORTHANC_PASSWORD

PASSWORD of collate orthanc

ACFLOW_ORTHANC_PROCESSED

--processed-label of collate orthanc

ACFLOW_ORTHANC_STORE_DIR

STORE_DIR of collate orthanc

ACFLOW_ORTHANC_TO_PROCESS

--to-process-label of collate orthanc

ACFLOW_ORTHANC_URL

URL of collate orthanc

ACFLOW_ORTHANC_USER

USER of collate orthanc

ACFLOW_OUTPUT_DIR

OUTPUT_DIR of annotate, attach, collate folder, deidentify, label folder, label xnat, package

ACFLOW_OUTPUT_RESOURCES

--output-resource of package

ACFLOW_OVERWRITE

--overwrite of store folder

ACFLOW_PASS

--password of check-store xnat, store xnat

ACFLOW_PATH_METADATA

--path-metadata of collate folder

ACFLOW_PATH_METADATA_REGEX

--path-metadata-regex of collate folder

ACFLOW_PROJECT

--project of label xnat

ACFLOW_RECIPE_DIR

RECIPE_DIR of deidentify

ACFLOW_RECURSIVE

--recursive of collate folder

ACFLOW_REID_DIR

--reid-dir of deidentify

ACFLOW_REID_ENCRYPT_KEY

--reid-encrypt-key of deidentify

ACFLOW_REQUIRE_MANIFEST

--require-manifest of attach, check-store folder, deidentify, package, store folder, store xnat

ACFLOW_RESOURCE

--resource of collate folder

ACFLOW_S3_MAX_WORKERS

--s3-max-workers of check-store folder, check-store xnat, store folder, store xnat

ACFLOW_SCAN

--scan of label xnat

ACFLOW_SESSION

--session of label xnat

ACFLOW_SOURCE_DATATYPE

SOURCE_DATATYPE of package

ACFLOW_SPACES_TO_UNDERSCORES

--spaces-to-underscores of attach

ACFLOW_SPEC_DIR

RECIPE_DIR of deidentify

ACFLOW_STAGED

STAGED of check-store folder, store folder, store xnat

INPUT_DIR of check-store xnat

ACFLOW_STORAGE_OPTIONS

--storage-option of check-store folder, store folder

ACFLOW_STORE_CREDENTIALS

--store-credentials of check-store folder, check-store xnat, store folder, store xnat

ACFLOW_SUBJECT

--subject of label xnat

ACFLOW_TEMPDIR

--temp-dir of attach, check-store folder, check-store xnat, package, store folder, store xnat

ACFLOW_UNLINK_SOURCE

--unlink-source of attach, collate folder, collate orthanc, deidentify, label folder, label xnat, package

ACFLOW_USER

--user of check-store xnat, store xnat

ACFLOW_USE_CURL_JSESSION

--use-curl-jsession of check-store xnat, store xnat

ACFLOW_VERIFY_SSL

--verify-ssl of check-store xnat, store xnat

ACFLOW_WAIT_PERIOD

--wait-period of collate folder, collate orthanc, store folder, store xnat

ACFLOW_XNAT_MAX_WORKERS

--xnat-max-workers of check-store xnat, store xnat