Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 3 KB

fixity.1.md

File metadata and controls

88 lines (63 loc) · 3 KB

fixity(1) -- Check fixity for AIPs

SYNOPSIS

fixity command [options] [UUID]

DESCRIPTION

fixity is a command line tool that assists in checking fixity for AIPs stored in the Archivematica Storage Service.

fixity is a client application that calls the Storage Service's Check Fixity API endpoint for a single AIP or for each AIP in the Storage Service. The Storage Service performs the fixity check itself and the results are reported on by the fixity client application.

fixity can be configured to POST its reports to a remote service after completing every scan. It also retains an internal database which keeps track of every AIP it's scanned and a report of every scan.

fixity requires several environment variables to be exported when it is running; see the section on ENVIRONMENT VARIABLES for information.

OPTIONS

  • --throttle <seconds>: Time (in seconds) to wait when scanning multiple AIPs. This can help reduce extended disk load on the Storage Service filesystem on which the AIPs reside.

  • --force-local: Request the Storage Service performs a local fixity check, instead of using the Space's fixity (this is only available for Arkivum Spaces).

  • --debug: Print extra debugging output.

  • --timestamps: It adds a timestamp to the beginning of each line of output.

  • --sort: Sort the AIPs based on result of fixity check success or failure.

COMMANDS

  • scan <UUID>: Run a fixity scan on a single AIP, using the specified UUID. If the UUID is malformed, or the Storage Service does not have an AIP with the specified UUID, this will produce an error and exit 1. After the scan completes, a brief report will be printed with information on whether the scan succeeded or failed.

  • scanall: Run a fixity scan on every AIP registered with the target Storage Service instance. This command does not take any arguments. A brief report will be printed after every AIP is scanned.

    If --throttle is passed, then the tool will pause for the specified number of seconds between scans.

ENVIRONMENT VARIABLES

The following environment variables must be exported in the environment for fixity to operate.

  • STORAGE_SERVICE_URL: The base URL to the storage service instance to scan. Must include the port number for non port 80 installations. Example: http://localhost:8000/

  • STORAGE_SERVICE_USER: Username for API authentication with the storage service. Example: test

  • STORAGE_SERVICE_KEY: API key for API authentication with the storage service. Example: dfe83300db5f05f63157f772820bb028bd4d0e27

  • REPORT_URL: The base URL to the remote service to which scan reports will be POSTed.

  • REPORT_USERNAME: Username for API authentication with the reporting service. Not all reporting services require API authentication; leave this unset if API access is unauthenticated.

  • REPORT_PASSWORD: Password for API authentication with the reporting service; see above.