sitectl-omeka-classic

README

sitectl-omeka-classic

sitectl-omeka-classic simplifies the creation and operation of repositories created using the LibOps Omeka Classic template. It provides sitectl commands for the Omeka Classic API, resource shortcuts, plugin maintenance, validation, and health checks.

Documentation: https://sitectl.libops.io/plugins/omeka-classic

Requirements

• sitectl.
• Docker with the Compose v2 plugin for local Omeka Classic sites.
• No additional app-plugin dependency beyond core sitectl.

Quick Start

Create a local Omeka Classic site from the matching template:

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

The template README is at https://github.com/libops/omeka-classic.

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 omeka-classic=nginx-1.30.3-php84

Use sitectl set and sitectl converge for component changes:

sitectl set ingress enabled --mode https-custom --domain omeka-classic.localhost
sitectl set ingress enabled --trusted-ip 203.0.113.10/32 --max-upload-size 2G --upload-timeout 10m
sitectl converge

See the Omeka Classic plugin docs for lifecycle operations, API helpers, resource shortcuts, and plugin maintenance.

License

sitectl-omeka-classic is licensed under the MIT License.