@moejaberr/sunbird
v0.2.0
Published
Master-compatible npm CLI launcher scaffold for Sunbird SIEM/XDR.
Readme
@moejaberr/sunbird
Master-compatible npm CLI launcher scaffold for Sunbird SIEM/XDR.
Install the Sunbird CLI from npm:
npm install -g @moejaberr/sunbird
sunbirdLocal Validation
npm pack
npm install -g ./moejaberr-sunbird-0.2.0.tgz
SUNBIRD_PRINT_URL=1 sunbird
sunbirdSUNBIRD_PRINT_URL=1 prints the URL without starting Docker. By default the
URL is http://localhost:8080/. If port 8080 is already used by a non-Sunbird
service, the CLI automatically chooses 8081 through 8090.
SUNBIRD_API_PORT=18080 sunbird sets the public UI/API proxy port explicitly.
Runtime Status
The default master runtime image set is digest-pinned and validated. The CLI
does not use latest, and the old main-branch sunbird-runtime digest is
intentionally not used here.
Packaged defaults:
API: ghcr.io/moejaberr/sunbird-api@sha256:f1d4d7c16f1e51418fb02e046c19582cf91da6d2580f455d02a9397065ad5640
Ingest: ghcr.io/moejaberr/sunbird-ingest@sha256:d8122d20a7f18bf56086f847a2303be6173376f54286455caaaadc20cf3438c1
Detection: ghcr.io/moejaberr/sunbird-detection@sha256:e366aea956b8cc2e12d8649123b84f3a7a306b9c0f214c459cfe9519c7ab639a
Frontend: ghcr.io/moejaberr/sunbird-frontend@sha256:ec4c39831532e22b75026561ffe37ba03a1ca678e71792d0383f1268db310196
Schema: ghcr.io/moejaberr/sunbird-schema@sha256:a74bb23a4f9a0b758485b2924f839b416d778cfb6b04bd3d4af2b218226d669bSet one or more exact image environment variables to override individual services:
SUNBIRD_API_IMAGE=<image> \
SUNBIRD_INGEST_IMAGE=<image> \
SUNBIRD_DETECTION_IMAGE=<image> \
SUNBIRD_FRONTEND_IMAGE=<image> \
SUNBIRD_SCHEMA_IMAGE=<image> \
sunbirdFor image-family testing, SUNBIRD_IMAGE is a master multi-service prefix, not
a single runtime image. It replaces the packaged default set, and exact service
variables can override individual expanded refs:
SUNBIRD_IMAGE=ghcr.io/moejaberr/sunbird SUNBIRD_VERSION=<tag> sunbirdThat expands to sunbird-api:<tag>, sunbird-ingest:<tag>,
sunbird-detection:<tag>, sunbird-frontend:<tag>, and
sunbird-schema:<tag>.
The schema image must provide /schema/postgres and /schema/clickhouse.
The package tarball intentionally includes only the CLI, runtime metadata, runtime Compose template, README, and license.
