Skip to content

    Type a page, a command such as keryn scan, or a rule id.

    Deployment models

    View as Markdown

    Keryn can be used locally, as a hosted service, through an API, or inside a partner’s product. Solid borders in the diagrams mean built, dashed mean partly built, dotted mean planned. OEM, white label, private label and headless are offered and scoped per agreement; an offered model can still be partly built, and the table says which parts.

    Keryn deployment models Seven deployment models arranged by who operates them. Local, self-hosted and OEM run in the customer or partner environment. SaaS, dedicated cloud, white label and private label run on Keryn Cloud. Headless API access spans both. Dashed borders are partial, dotted are roadmap. Customer or partner operates Keryn operates (Keryn Cloud) Self-hostedCLI + keryn-server on loopback,air-gapped guide OEMengine embedded in a partnerproduct; sales-led Private labelpartner delivers under its nameon Keryn Cloud orgs LocalCLI, desktop, web tab,extensions, CI. Free. Headless / API-only/api/v1 + organisation keys@keryn/sdk, @keryn/mcp, @keryn/skillsCLI --json, SARIF, CycloneDX keryn-export/1opt-in file; import into a KerynCloud org. Nothing uploads by default. SaaSaccount UI, API, credits,SSO, SCIM Dedicated / private cloudsingle-tenant Keryn Cloud White labelpartner-branded service onKeryn Cloud; sales-led solid: real dashed: partial dotted: roadmap
    Model Who operates it Today
    Local: CLI, desktop, web tab, extensions, CI You Available. Free. Nothing uploads by default
    SaaS: Keryn Cloud Keryn Partly built: account UI, API, organisations, SSO, SCIM, credits. Scans are bounded; credit billing runs in shadow mode
    Dedicated or private cloud Keryn, single tenant Planned. An operator can deploy it by hand; there is no packaged offer yet
    Self-hosted You Partly built: CLI and CI, keryn-server on loopback, air-gapped use. A customer-run Keryn Cloud is not supported
    Headless or API-only Keryn (hosted API) or you (CLI) Partly built: API with organisation keys; @keryn/sdk, @keryn/mcp and @keryn/skills listed under npm in Download
    OEM The partner, inside its product Partly built: contract-versioned CLI outputs, release evidence, conformance fixtures. No packaged library yet
    White label Keryn, under the partner’s brand Planned: custom domain, partner branding and partner admin do not exist yet
    Private label Keryn runs the platform, the partner delivers Partly built as a manual arrangement on Keryn Cloud; attribution stays until agreed in writing

    In Keryn Cloud every customer is an organisation. Sign-in uses passkeys, email links, a password, or GitHub or Google. Organisation administrators can register an OIDC or SAML identity provider after proving domain ownership, and can require it, and require a second factor, for the organisation. SCIM provisions members from the customer’s directory and removes them on deactivation. Automation uses organisation-owned API keys with scopes, project restrictions and expiry.

    Billing is by Keryn Credits: one balance across products, charged for work done and not for work repeated. A new organisation can claim a starter credit; local scanning is free. Plans, top-ups and what each credit buys are on Plans and prices. A partner maps to one organisation per end customer; a partner-to-customer hierarchy and partner console are planned.

    OEM and headless architecture A partner product with its own UI, accounts and billing calls Keryn through contract-versioned surfaces: the CLI and SARIF, the hosted customer API with the TypeScript client, @keryn/mcp and @keryn/skills. These reach the Keryn engine locally or Keryn Cloud, which holds organisations, credits and jobs. Evidence returns as SARIF, CycloneDX and keryn-export envelopes, with release evidence delivered with each build. Partner product (partner operates) Contract-versioned surfaces Keryn Partner UI, workflow, CIscheduling, reports, runners,first-line support Partner accounts + billingend-customer contracts;maps to one Keryn org each Partner agentscall Keryn as tools CLI + SARIF + CycloneDX--json, exit codes,keryn-export/1 Customer API + @keryn/sdk/api/v1, org API keys,Idempotency-Key @keryn/mcp + @keryn/skills7 skills; MCP over stdio andHTTP (thin npm packages) Keryn engine (local)rules, known-fix database,no telemetry Keryn Cloudorgs, SSO, SCIM, jobs,credit ledger and billing Evidence outfindings with proof level,coverage, decisions Release evidencemanifest, SBOM, provenance;pin the contract version solid: real dashed: partial dotted: roadmap

    A partner product calls Keryn through contract-versioned surfaces and keeps its own interface, accounts and billing. Pin the contract version, not only the application version, and keep the release evidence that comes with every build.

    Data flow and trust boundaries Source code and local scans stay on the customer machine. Only an explicit export file or a hosted scan request crosses into Keryn Cloud, authenticated by a session or an organisation API key. Inside Keryn Cloud the API tier, a credential-free scan worker and the database are separate; payments, usage metering and email go to third-party providers, identity federation to the customer's identity provider. Customer machine or CI (trust boundary 1) Keryn Cloud (trust boundary 2) Third parties (trust boundary 3) Source and configsnever uploaded by default Local engineCLI, desktop, web tab;free, no telemetry .keryn/ decisionsreviewed in pull requests API tierBetter Auth session or org key;membership rechecked per request Scan workercredential-free child process,bounded time and memory PostgresRLS on; tenant predicates in API;append-only audit; 30-day payload expiry Credit ledgerreserve, settle, receipts Customer IdPOIDC / SAML, SCIM Email providersign-in links Payment providerprepaid checkout,signed webhooks Usage meteringcredit grants, usage,invoices (shadow today) opt-in export or hosted scan SSO, SCIM signed webhook credits solid: real dashed: partial dotted: roadmap

    Source code and local scans stay on the customer’s machine. Only an opt-in export file or a request to Keryn Cloud crosses the first boundary, authenticated by a session or an organisation key. Inside Keryn Cloud the API tier, a credential-free scan worker and the database are separate; payments, usage metering and email go to third parties. See Keryn Cloud data and limits for what is kept and for how long.

    For an OEM, private-label or white-label partner the partner is the first line for its customers and Keryn is the second line for Keryn behaviour. Severity levels and response targets are set in the agreement. Local and community use is supported through the documentation.

    Become a partner or return to the partners overview.