Utilities

Utilities are stand-alone programs shipped with the Pocket Archive installation. These include a command-line admin tool and some daemons that can be run depending on needs of the archive.

Each of these commands points to a specific archive in the system, indicated by the PKAR_ROOT and PKAR_CONFIG_DIR environment variables. Multiple archives can thus be managed on the same system.

pkar

This command-line utility performs various administrative tasks necessary to run the archive. They include:

  • deposit: deposit a local SIP.
  • dump-archive: dump the whole archive as serialized RDF.
  • dump-ll: dump the laundry list CSV for a resource or a whole submission.
  • dump-res: dump the RDF for a single resource.
  • dump-schema: dump the schema definition for a content type.
  • gen-cmdoc: generate content model documentation as a static site.
  • gen-site: generate the presentation static site.
  • init: initialize the archive and clear all preexisting contents. Careful!
  • list: list all resource and submission URIs in the archive.
  • list-ctypes: dump a plain list of content type identifiers that can be used with dump-schema.
  • list-subs: List all submissions with some basic details.
  • remove: Remove a resource.

The full list of command can also be viewed by entering pkar, and detailed information about each command with pkar <command> --help.

pkar_watch

Start a submission watchdog service. It is up to the administrator to create a permanent service (e.g., via systemd) and set up a proxy for secure remote access, such as Nginx.

pkar_http

Start an admin interface as a web service that runs on a port defined in the http.port section of the application configuration (by default, 5000). This service also can be set up as a system service to run automatically.