Skip to content

Commit

Permalink
Add some more changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Dhwaniartefact committed Jun 21, 2024
1 parent 1333731 commit 4279dbd
Show file tree
Hide file tree
Showing 4 changed files with 186 additions and 171 deletions.
294 changes: 153 additions & 141 deletions docs/fixity.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

59 changes: 31 additions & 28 deletions docs/fixity.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,59 +24,62 @@ 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.
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).
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.
Print extra debugging output.

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

## 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.
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.
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.
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/>
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
Username for API authentication with the storage service. Example:
test

* **STORAGE_SERVICE_KEY**:
API key for API authentication with the storage service. Example:
dfe83300db5f05f63157f772820bb028bd4d0e27
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.
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.
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.
Password for API authentication with the reporting service; see above.
Loading

0 comments on commit 4279dbd

Please sign in to comment.