Deployment models
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.
| 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 |
Organisations, SSO and billing
Section titled “Organisations, SSO and billing”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
Section titled “OEM and headless architecture”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
Section titled “Data flow and trust boundaries”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.
Support boundaries
Section titled “Support boundaries”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.