create

package

v0.17.0 Latest Latest Go to latest Published: Jul 1, 2026 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/libops/sitectl-isle

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Apply(opts Options) error
func ApplyBotMitigation(projectDir, state string) error
func ApplyDerivativeServices(opts Options) error
func ApplyIIIF(opts Options) error
func BotMitigationOptions() coretraefik.BotMitigationOptions
func DerivativeServiceNames() []string
func IsDerivativeService(name string) bool
func SyncBotMitigationBypass(projectDir string) error
func SyncLocalDrupalInternalIngress(projectDir string, enabled bool) error
func TrustedHostPatterns(domain string, includeLocalDrupal bool) string
type DerivativeServiceSpec
- func DerivativeServiceSpecs() []DerivativeServiceSpec
type Options

Constants ¶

View Source

const (
	FcrepoStateOn  = "on"
	FcrepoStateOff = "off"

	IIIFCantaloupe       = "cantaloupe"
	IIIFTriplet          = "triplet"
	IIIFTopologyLocal    = "local"
	IIIFTopologyExternal = "external"

	DerivativeTopologyLocal       = "local"
	DerivativeTopologyDistributed = "distributed"

	CodebaseNested  = "nested"
	CodebaseGitRoot = "git-root"

	DefaultDrupalRootfs      = "drupal/rootfs/var/www/drupal"
	DefaultISLEFileSystemURI = "private"
	PublicISLEFileSystemURI  = "public"
	PrivateISLEFileSystemURI = "private"

	// LocalDrupalBaseURL is the internal Traefik route used by local Fcrepo
	// clients that cannot reach the host machine's localhost.
	LocalDrupalBaseURL = "http://" + localDrupalHost
)

View Source

const DefaultTrustedHostPatterns = "^localhost$"

DefaultTrustedHostPatterns is the Drupal trusted-host regex for local sites.

Variables ¶

This section is empty.

Functions ¶

func Apply ¶

func Apply(opts Options) error

func ApplyBotMitigation ¶ added in v0.12.0

func ApplyBotMitigation(projectDir, state string) error

func ApplyDerivativeServices ¶ added in v0.13.0

func ApplyDerivativeServices(opts Options) error

ApplyDerivativeServices applies the requested local or distributed topology for derivative services in docker-compose.yml and docker-compose.dev.yml.

func ApplyIIIF ¶ added in v0.11.0

func ApplyIIIF(opts Options) error

func BotMitigationOptions ¶ added in v0.17.0

func BotMitigationOptions() coretraefik.BotMitigationOptions

func DerivativeServiceNames ¶ added in v0.13.0

func DerivativeServiceNames() []string

DerivativeServiceNames returns the derivative service names in catalog order.

func IsDerivativeService ¶ added in v0.13.0

func IsDerivativeService(name string) bool

IsDerivativeService reports whether name is a known derivative service.

func SyncBotMitigationBypass ¶ added in v0.17.0

func SyncBotMitigationBypass(projectDir string) error

func SyncLocalDrupalInternalIngress ¶ added in v0.17.0

func SyncLocalDrupalInternalIngress(projectDir string, enabled bool) error

func TrustedHostPatterns ¶ added in v0.17.0

func TrustedHostPatterns(domain string, includeLocalDrupal bool) string

TrustedHostPatterns returns comma-separated Drupal trusted host regexes.

Types ¶

type DerivativeServiceSpec ¶ added in v0.13.0

type DerivativeServiceSpec struct {
	Name        string
	ImageRef    string
	AlpacaEnv   string
	ExternalURL string
	LocalURL    string
	NeedsJWT    bool
}

DerivativeServiceSpec describes one derivative microservice and the URLs used when it runs locally or through the managed LibOps endpoint.

func DerivativeServiceSpecs ¶ added in v0.13.0

func DerivativeServiceSpecs() []DerivativeServiceSpec

DerivativeServiceSpecs returns the canonical derivative service catalog.

type Options ¶

type Options struct {
	Path               string
	DrupalRootfs       string
	Fcrepo             string
	Blazegraph         string
	IIIF               string
	IIIFTopology       string
	IIIFUpstreamURL    string
	BotMitigation      string
	ComposeOverride    string
	ISLEFileSystemURI  string
	DerivativeServices map[string]string
	Codebase           string
}

Source Files ¶

View all Source files

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