sitectl-isle

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 17, 2026 License: MIT Imports: 3 Imported by: 0

README

sitectl-isle

sitectl-isle simplifies the creation and operation of repositories created using the LibOps ISLE template. It uses sitectl components to make features like Traefik bot mitigation, Triplet IIIF, and Islandora filesystem storage easy to enable and customize.

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

Requirements

  • sitectl.
  • Docker with the Compose v2 plugin for local ISLE sites.
  • sitectl-drupal, because ISLE includes and extends the Drupal plugin surface.

Quick Start

Create a local ISLE site from the matching template:

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

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

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 drupal=nginx-1.30.3-php84 --tag solr=9

Use sitectl set for component changes. It updates the component-owned project files immediately:

sitectl set bot-mitigation on

Feature bundles converge a complete Islandora capability across Compose, Drupal configuration, and (when needed) composer.json:

# Add the upstream mergepdf service and paged-content action.
sitectl set mergepdf enabled --islandora-tag 6.3.19

# Add hOCR generation, IIIF annotations, Solr indexing, and search.
# Use the term ID for https://discoverygarden.ca/use#hocr on this site.
sitectl set hocr-search enabled --hocr-term-id 56

The commands edit source-controlled project files but do not fabricate a Composer lock file or run a production data backfill. Review the diff, update composer.lock when hOCR changes, rebuild the Drupal image, import Drupal configuration, and then generate/reindex existing content as the command's follow-up output directs. mergepdf requires islandora/alpaca:6.3.19 or newer when the project uses the upstream Alpaca image; hOCR requires islandora/solr:4.2.1 or a compatible LibOps Solr image.

Use sitectl converge later to inspect and repair component drift after manual edits or upstream updates.

See the ISLE plugin docs for Fedora, Blazegraph, IIIF, derivatives, sync, migration, cache, TLS, and bot mitigation details.

License

sitectl-isle is licensed under the MIT License.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL