Public Documentation
Use these guides to launch quickly, complete security reviews, run reliable operations, and solve common issues independently.
Go from workspace creation to first findings in one guided path with clear next steps and ownership checks.
15-20 minutes
Create your workspace, first administrator, and integration keys so your team can start ingesting findings safely.
Open guided pathChoose the fastest copy-paste setup for CI, cloud, Kubernetes, SaaS, or host telemetry, then validate ingestion.
2 minutes
Embed Trivy, Semgrep, TruffleHog, and Syft into every commit with a single workflow file. Works with GitHub Actions, GitLab CI, and Bitbucket Pipelines.
Open deployment guideAnswer buyer, legal, and security-review questions with trust-center, shared-responsibility, and evidence guides.
12-18 minutes
BlackShield should earn trust with concrete product controls: authenticated workspace access, rate-limited sensitive actions, triage workflows in `/findings` and `/alerts`, and exportable evidence from `/reports`, `/audit`, and `/compliance`.
Open trust guideStart here to resolve the most common onboarding and ingestion blockers.
Open troubleshootingUse the trust center and questionnaire pack to answer legal and security due-diligence requests.
Open trust center packageFor urgent production incidents, include workspace details, job IDs, and timestamps in your support request.
Contact supportDeveloper Quick Starts
Start with a working snippet, copy the command or file, then open the full guide only if you need deeper rollout detail.
Copy a working starter, run it in your environment, then come back here for the deeper rollout details.
GitHub Actions
Drop one workflow into the repository and run Trivy, Semgrep, TruffleHog, and Syft in parallel.
BLACKSHIELD_PIPELINE_IMAGE=public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/github-security-scan.sh)GitLab CI
Add one security stage that scans merge requests, default-branch builds, and scheduled pipelines.
BLACKSHIELD_PIPELINE_IMAGE=public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gitlab-ci.sh)GitHub Deploy Gate
Drop in one workflow that evaluates the hosted Rego decision API before production deploys and prints the reasons inline.
BLACKSHIELD_POLICY_IMAGE=public.ecr.aws/blackshield-security/policy-client:1.0.0 \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/github-policy-guardrails.sh)GitLab Deploy Gate
Add one reusable deploy job that checks allow, warn, or deny outcomes against your tenant policy pack before release.
BLACKSHIELD_POLICY_IMAGE=public.ecr.aws/blackshield-security/policy-client:1.0.0 \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gitlab-policy-guardrails.sh)AWS Lambda
Bootstrap the AWS CDK project locally, then deploy the tenant-owned cloud posture scanner without rewriting the commands.
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/aws-cloud-scanner.sh)
cd deploy/aws-cloud-scannerGCP Cloud Run
Bootstrap the Terraform module locally, then deploy the cloud scanner to your target projects and regions with the same commands shown in the guide.
BLACKSHIELD_CLOUD_IMAGE=public.ecr.aws/blackshield-security/cloud-scanner:1.0.0 \
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gcp-cloud-scanner.sh)
cd deploy/gcp-cloud-scannerKubernetes
Pull the Helm chart source locally, review the templates, and install the cluster scanner from your own repository.
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/k8s-scanner-helm.sh)
cd deploy/helm/blackshield-k8s-scannerSaaS on AWS
Bootstrap the AWS CDK project locally, then deploy the tenant-owned Lambda scanner without rewriting the commands.
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/aws-saas-scanner.sh)
cd deploy/aws-saas-scannerSaaS on GCP
Bootstrap the Terraform module locally, then deploy the Cloud Run Job scanner with the same commands shown in the guide.
BLACKSHIELD_SAAS_IMAGE=public.ecr.aws/blackshield-security/saas-scanner:1.0.0 \
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gcp-saas-scanner.sh)
cd deploy/gcp-saas-scannerAgent Runtime
Download the Compose bootstrap, point it at your tenant, and start governed blue-team automation with approval gates around every mutation.
BLACKSHIELD_SECURITY_AGENT_IMAGE=public.ecr.aws/blackshield-security/security-agent:1.0.0 \
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/security-agent-docker.sh)
cd deploy/security-agentUse the guided steps below when you want to tailor the rollout, validate ownership, or expand the deployment safely.
3 minutes
Add a lightweight CI step that sends deploy context to your tenant and gets an allow, warn, or deny decision back without self-hosting OPA.
5 minutes
Run BlackShield's governed Go security agent inside your environment with tenant-scoped assignments, MCP context, AI Gateway controls, and approval gates around every mutation.
5 minutes
Scan GCP project posture with Prowler via a serverless Cloud Run Job triggered by Cloud Scheduler. One Terraform apply deploys to any number of projects and regions.
10 minutes
Capture live network traffic using VPC Traffic Mirroring, deploy sensor instances with CloudFormation or CDK, and stream findings automatically to the platform.
5-15 minutes
Diagnostic runbook for container startup, traffic capture, API connectivity, health checks, resource usage, and ingestion gaps.
Browse the full catalog once you know whether you are onboarding, deploying, reviewing trust posture, or solving an operational issue.
Fastest path from account creation to first validated findings.
Run scans, triage risk, and build a repeatable remediation workflow.
Copy-paste-ready deployment guides for every scanner type plus the governed security agent runtime — CI/CD pipelines, cloud posture, Kubernetes, SaaS OAuth, host intrusion detection, and network telemetry.
Buyer-facing proof of how BlackShield handles access control, evidence, data rights, control coverage, and offboarding in the actual product.
Understand availability commitments, incident flow, continuity planning, troubleshooting, and network sensor operations.
15-20 minutes
Create your workspace, first administrator, and integration keys so your team can start ingesting findings safely.
Audience: Workspace owners and first tenant administrators
Read guide30-45 minutes
Use this day-one checklist to move from an empty workspace to validated findings and clear ownership.
Audience: New tenant admins and security leads
Read guide10-15 minutes
Run your first scan, submit findings, and confirm data quality before expanding to more integrations.
Audience: Security engineers, CI owners, and integration engineers
Read guideOngoing, daily review recommended
Prioritize remediation using risk, exploitability, ownership, and tenant policy tuning so teams fix what matters first.
Audience: Security triage teams, engineering leads, and service owners
Read guideFirst 30 days
Convert initial findings into a repeatable security program with clear metrics, ownership, and reporting.
Audience: Security program owners and engineering managers
Read guide2 minutes
Embed Trivy, Semgrep, TruffleHog, and Syft into every commit with a single workflow file. Works with GitHub Actions, GitLab CI, and Bitbucket Pipelines.
Audience: DevOps engineers, platform engineers, and security engineers
Read guide3 minutes
Add a lightweight CI step that sends deploy context to your tenant and gets an allow, warn, or deny decision back without self-hosting OPA.
Audience: Platform engineers, release managers, and security engineers
Read guide5 minutes
Scan your AWS environment for misconfigurations with Prowler, deployed as a Lambda container on EventBridge Scheduler — no EC2, no always-on compute.
Audience: Cloud engineers, security engineers, platform teams
Read guide5 minutes
Scan GCP project posture with Prowler via a serverless Cloud Run Job triggered by Cloud Scheduler. One Terraform apply deploys to any number of projects and regions.
Audience: Cloud engineers, security engineers, platform teams
Read guide2 minutes
Scan cluster posture with kube-bench (CIS benchmarks), kubescape, and Kyverno policy telemetry. One Helm chart install, one kubectl secret — done.
Audience: Platform engineers, Kubernetes administrators, security engineers
Read guide5 minutes
Discover over-privileged OAuth grants, stale app access, and shadow AI tool sprawl across Google Workspace, Microsoft 365, and GitHub. Runs entirely inside your tenant boundary.
Audience: Security engineers, identity and access management teams, platform engineers
Read guide3 minutes
Ingest OSSEC and Wazuh host intrusion detection alerts into the platform for correlation with cloud and container findings. Works with Docker Compose, systemd, or ECS Fargate.
Audience: Security operations teams, infrastructure engineers
Read guide5 minutes
Run BlackShield's governed Go security agent inside your environment with tenant-scoped assignments, MCP context, AI Gateway controls, and approval gates around every mutation.
Audience: Security engineers, platform engineers, and security operations teams
Read guide10 minutes
Capture live network traffic using VPC Traffic Mirroring, deploy sensor instances with CloudFormation or CDK, and stream findings automatically to the platform.
Audience: Platform engineers, network architects, security engineers
Read guide10 minutes
Stream live traffic using Packet Mirroring, deploy sensor VM with Terraform, and ingest findings via the managed SIEM connector.
Audience: Platform engineers, GCP administrators, security engineers
Read guide10 minutes
Capture traffic using Virtual Network TAP, deploy sensor VM with Bicep, and bridge network telemetry into the security platform.
Audience: Platform engineers, Azure administrators, security engineers
Read guide5-15 minutes
Diagnostic runbook for container startup, traffic capture, API connectivity, health checks, resource usage, and ingestion gaps.
Audience: Operations engineers, DevOps teams, security operations teams
Read guide10 minutes
Capacity planning, performance tuning, and sizing guidance for high-volume network telemetry ingestion.
Audience: Platform architects, operations engineers, security engineers
Read guide15 minutes
Design resilient network sensor deployments with failover, load balancing, and multi-region architectures.
Audience: Platform architects, network engineers, SRE teams
Read guide10-15 minutes
BlackShield should tell customers exactly which record categories exist in the workspace, which ones appear in tenant-admin screens, and which legal documents cover processor and privacy commitments.
Audience: Security buyers, legal teams, privacy teams, and procurement stakeholders
Read guide12-18 minutes
BlackShield should earn trust with concrete product controls: authenticated workspace access, rate-limited sensitive actions, triage workflows in `/findings` and `/alerts`, and exportable evidence from `/reports`, `/audit`, and `/compliance`.
Audience: Security buyers, procurement leads, legal teams, and risk stakeholders
Read guide15-20 minutes
Answer buyer questionnaires by pointing to concrete BlackShield controls: identity setup, API key governance, audit exports, compliance evidence, and tenant self-service deletion.
Audience: Security buyers, procurement teams, legal reviewers, and revenue teams supporting due diligence
Read guide15 minutes
BlackShield should tell customers exactly how offboarding works: open `/tenant-rights`, confirm the workspace snapshot, collect any needed audit or report exports, then run the tenant deletion flow with a typed confirmation phrase.
Audience: Compliance, legal, procurement, and platform operations teams
Read guide10 minutes
Understand incident severity, escalation flow, and communication expectations so your team can respond quickly.
Audience: Security leads, operations teams, and customer success teams
Read guide8-12 minutes
Review uptime targets, support response commitments, and escalation channels by plan tier.
Audience: Operations, support, procurement, and service owners
Read guide15-20 minutes
Build leadership-ready remediation reporting with MTTR, critical/high backlog, SLA performance, and ownership rollups tied to CIS and NIST governance language.
Audience: Security leaders, engineering managers, tenant admins, and customer-facing stakeholders
Read guide10-15 minutes
BlackShield turns mapped findings into a benchmark heatmap, service rollups, control drill-down, and a CSV export so customers can prove where coverage exists and where gaps still need work.
Audience: Security leads, auditors, tenant admins, service owners, and buyers validating control visibility
Read guide12-20 minutes
Plan recovery objectives, failover validation, and communication steps before a major service disruption.
Audience: Platform operations teams and business continuity owners
Read guide10 minutes
BlackShield owns the product controls in the platform; your team owns the way you configure identities, keys, scan scope, and operational approvals inside your workspace.
Audience: Security architects, compliance owners, procurement reviewers, and platform administrators
Read guide12-15 minutes
BlackShield protects its APIs with authenticated access, role checks, rate limits on sensitive flows, and audit trails for evidence access and administrative changes.
Audience: Security architects, AppSec reviewers, buyers, and compliance stakeholders
Read guide15-20 minutes
BlackShield gives tenant admins a concrete identity surface: configure Google, Okta, or Azure AD, validate OIDC before enabling it, map groups to roles, rotate SCIM tokens, and review identity audit activity.
Audience: IT admins, security operations teams, workspace owners, and procurement reviewers validating access control
Read guide10-15 minutes
BlackShield gives authorized users a concrete audit workflow: filter events by action, actor, and time range, then export CSV or JSON evidence while recording the export itself in the audit trail.
Audience: Security admins, compliance teams, auditors, and buyers validating accountability
Read guide10-15 minutes
Today, BlackShield gives tenant admins a self-service account snapshot and workspace deletion flow in `/tenant-rights`; if your process requires evidence before deletion, capture it from `/audit` and `/reports` first.
Audience: Tenant admins, privacy officers, legal stakeholders, and buyers reviewing customer data control
Read guide15-20 minutes
Connect one approved provider key, create a client for your IDE or automation, test the gateway, and apply a simple policy pack your team can understand.
Audience: Tenant admins, security leads, and workspace owners
Read guide20-30 minutes
Run a practical multi-scanner troubleshooting playbook for ingestion, authentication, provider connectivity, and throughput so teams can isolate failures fast across CI, cloud, SaaS, Kubernetes, and VM sources.
Audience: Tenant admins, DevOps teams, scanner operators, integration owners, and support engineers
Read guide5-10 minutes
Automate the deployment of Threat Intel indicators directly into your security stack, including AWS WAF, Egress Proxies, DNS sinkholes, and EDR systems.
Audience: Security engineers, SOC analysts, and network administrators
Read guide