sitectl-archivesspace

sitectl-archivesspace

sitectl-archivesspace simplifies the creation and operation of repositories created using the LibOps ArchivesSpace template. It provides sitectl commands for the ArchivesSpace API, resource shortcuts, container scripts, validation, and health checks.

Documentation: https://sitectl.libops.io/plugins/archivesspace

Requirements

• Stable sitectl v1.0.0 or newer; this plugin uses RPC protocol 1.
• Docker with the Compose v2 plugin for local ArchivesSpace sites.
• No additional app-plugin dependency beyond core sitectl.

Quick Start

Create a local ArchivesSpace site from the matching template:

sitectl create archivesspace/default \
  --template-repo https://github.com/libops/archivesspace \
  --path ./my-archivesspace-site \
  --type local \
  --checkout-source template \
  --default-context

The template README is at https://github.com/libops/archivesspace.

Basic Operations

Use sitectl compose to start or inspect the stack:

sitectl compose up --remove-orphans -d

Use sitectl healthcheck and sitectl validate to check the site:

sitectl healthcheck
sitectl validate

Use sitectl image for local image or build-arg overrides:

sitectl image set --tag archivesspace=4.2.0 --tag solr=4.2.0

The plugin intentionally does not register broad development bind mounts because they can hide application content bundled in the base image. Add customizations through the downstream build or a narrowly targeted override.

Use sitectl set for component changes; it updates component-owned files immediately:

sitectl set ingress enabled --mode https-custom --domain archivesspace.localhost
sitectl set ingress enabled --trusted-ip 203.0.113.10/32

See the ArchivesSpace plugin docs for API helpers, resource shortcuts, container scripts, lifecycle operations, and rollout details.

License

sitectl-archivesspace is licensed under the MIT License.